@timum/booking 1.5.6 → 1.6.0

package/README.md

@@ -8,31 +8,31 @@ This documentation guides you through all the customization capabilities.
 ## Content
 
 - [Features](#features)
-- [How to Integrate](#how_to_integrate)
-  - [In a Script Tag](#in_a_script_tag)
-  - [As ESM import](#as_esm_import)
-  - [Entity Referencing](#entity_referencing)
-    - [Channel Reference](#channel_reference)
-    - [Resource Reference](#resource_reference)
-    - [Resource Reference + `channelKey`](#channel_reference_channel_key)
+- [How to Integrate](#how-to-integrate)
+  - [In a Script Tag](#in-a-script-tag)
+  - [As ESM import](#as-esm-import)
+  - [Entity Referencing](#entity-referencing)
+    - [Channel Reference](#channel-reference)
+    - [Resource Reference](#resource-reference)
+    - [Resource Reference + `channelKey`](#channel-reference-channel-key)
       - [Example](#example)
-    - [Customer pre-identification](#customer_pre_identification)
-      - [Identification via pData](#identification_via_pdata)
-      - [Identification via logged-in User](#identification_via_logged_in_user)
-- [Advanced Customisation](#advanced_usage)
-  - [muiTheme](#mui_theme)
-  - [fcConfig](#fc_config)
-  - [appConfig](#app_config)
-  - [How to use Callbacks](#how_to_use_callbacks)
-    - [Booking Related](#booking_related)
-    - [Cancelation Related](#cancelation_related)
-    - [Data Fetching Related](#data_fetching_related)
+    - [Customer pre-identification](#customer-pre-identification)
+      - [Identification via pData](#identification-via-pdata)
+      - [Identification via logged-in User](#identification-via-logged-in-user)
+- [Advanced Customisation](#advanced-usage)
+  - [muiTheme](#mui-theme)
+  - [fcConfig](#fc-config)
+  - [appConfig](#app-config)
+  - [How to use Callbacks](#how-to-use-callbacks)
+    - [Booking Related](#booking-related)
+    - [Cancelation Related](#cancelation-related)
+    - [Data Fetching Related](#data-fetching-related)
   - [Localisation](#localisation)
   - [Booking Form Fields](#bookingFormFields)
     - [Custom Fields](#customFields)
   - [Custom Field Example](#CustomFieldExample)
-    - [The Scenario](#the_scenario)
-    - [The Implementation](#the_implementation)
+    - [The Scenario](#the-scenario)
+    - [The Implementation](#the-implementation)
 
 <a name=”features”></a>
 
@@ -54,11 +54,11 @@ This documentation guides you through all the customization capabilities.
 - Support for multiple languages (English and German included) - add your own language
 - Callbacks for custom code execution and event response (e.g. booking created, appointments loaded, booking canceled)
 
-<a name=”how_to_integrate”></a>
+<a name=”how-to-integrate”></a>
 
 ## How to Integrate
 
-<a name=”in_a_script_tag”></a>
+<a name=”in-a-script-tag”></a>
 
 ### In a Script Tag
 
@@ -88,7 +88,7 @@ Alternatively, you can add `ref` to your url as a parameter. This allows you to
 </script>
 ```
 
-<a name=”as_esm_import”></a>
+<a name=”as-esm-import”></a>
 
 ### As ESM import
 
@@ -109,28 +109,28 @@ init({ ref: 'booking-widget-demo-resource@timum' });
 
 A example project can be found [here](https://stackblitz.com/edit/react-8q6r8b?file=src/index.js)
 
-<a name="entity_referencing"></a>
+<a name="entity-referencing"></a>
 
 ### Entity Referencing
 
-As shown in [How to Integrate](#how_to_integrate), there are two ways in which to provide bookingjs with the necessary references to retrieve public appointments from the backend.
+As shown in [How to Integrate](#how-to-integrate), there are two ways in which to provide bookingjs with the necessary references to retrieve public appointments from the backend.
 
 Additionally, there are three different kinds of references you can provide, each having their own implications concerning the delivered appointments or whether the booking frontend is shown at all.
 
-<a name="channel_reference"></a>
+<a name="channel-reference"></a>
 
 #### Channel Reference
 
 Resource channels are entities in Timum, each storing a configuration that changes the booking experience for customers. Each individual resource has four channels that users can distribute to their customers through a link.
 To use these channels in an embed scenario, provide a channel reference in the ref property (either in the URL or as part of the config). In this case, nothing else is required.
 
-<a name="resource_reference"></a>
+<a name="resource-reference"></a>
 
 #### Resource Reference
 
 A reference that refers to a plain resource, where the channel is unknown. The default channel (and its corresponding configuration) is used instead.
 
-<a name="channel_reference_channel_key"></a>
+<a name="channel-reference-channel-key"></a>
 
 #### Resource Reference + `ChannelKey`
 
@@ -161,14 +161,14 @@ The following table gives an overview of the different permutations and how book
 
 - Fifth row: If a resource reference and a `channelKey` are provided in the config object, and there is nothing in the URL, the config object is used. BookingJs gets displayed using the channel uniquely identified by the resource reference and the `channelKey`.
 
-<a name="customer_pre_identification"></a>
+<a name="customer-pre-identification"></a>
 
 #### Customer pre-identification
 
 BookingJs can identify customers automatically if configured correctly.
 This means they don't need to input their personal data prior to booking.
 
-<a name="identification_via_pdata"></a>
+<a name="identification-via-pdata"></a>
 
 ##### Identification via pDataId (personId)
 
@@ -178,7 +178,7 @@ General behaviour: If there is, then visitor is pre identified. If not: provide
 </em>
 See [appConfig](#appconfig) for more information about pData.
 
-<a name="identification_via_logged_in_user"></a>
+<a name="identification-via-logged-in-user"></a>
 
 ##### Identification via Logged-in User
 
@@ -188,7 +188,7 @@ Even customers can register at timum and become registered and logged-in users.
 
 ---
 
-<a name=”advanced_usage”></a>
+<a name=”advanced-usage”></a>
 
 ## Advanced usage
 
@@ -203,7 +203,7 @@ The following table gives a rough overview over each.
 | muiTheme  | object, mui theme allowing you to change the look and feel of timum. Requires a professional plan. |
 | fcConfig  | object, only used if you use full calendar as a booking frontend (settable in appConfig).          |
 
-<a name=”mui_theme”></a>
+<a name=”mui-theme”></a>
 
 ### muiTheme
 
@@ -214,7 +214,7 @@ When you open the file `config.js` in [this](https://stackblitz.com/edit/react-8
 
 Needs professional plan.
 
-<a name=”fc_config”></a>
+<a name=”fc-config”></a>
 
 ### fcConfig
 
@@ -246,7 +246,7 @@ There are also some options specific to bookingjs. In addition to the configurat
    </tr>
 </table>
 
-<a name=”app_config”></a>
+<a name=”app-config”></a>
 
 ### appConfig
 
@@ -341,7 +341,7 @@ This object's options directly affect timum's behaviour or allow you to react to
       <td>string, timum has, as of now, 4 different channels through which you can share your resource's appointments. <br> You can find them in the timum frontend under &lt;resource name&gt; -&gt; Calendar Sharing (Terminbuchung freigeben). <br> Every channel has its own settings allowing you to control whom of your customers can see certain appointments, whether they book directly or create a request first and other settings. <br> Valid values for this attribute are: <br> 
          - RESOURCE_PUBLIC <br> referring to "Public Booking Link" (Öffentlicher Buchungs-Link) <br> 
          - RESOURCE_EXCLUSIVE <br> referring to "Exclusive Booking Access" (Exklusiver Buchungs-Zugang) <br> 
-         - RESOURCE_REFERENCE <br> referring to "Embedded booking calendars" (Eingebettete Buchungskalender) <br>
+         - resource-reference <br> referring to "Embedded booking calendars" (Eingebettete Buchungskalender) <br>
          - CALENDAR_PUBLIC <br> referring to "In all Website Plugin Views and your General Calendar" (In Website-Plugin Ansichten sowie Ihrem Gesamtkalender) <br>RESOURCE_PUBLIC is the default, used if you specify nothing else. <br><br>Can also be a url parameter. 
       </td>
    </tr>
@@ -384,13 +384,13 @@ This object's options directly affect timum's behaviour or allow you to react to
    </tr>
 </table>
 
-<a name=”how_to_use_callbacks”></a>
+<a name=”how-to-use-callbacks”></a>
 
 #### How to use callbacks
 
 The callbacks object may contain any of the following functions.
 
-<a name=”booking_related”></a>
+<a name=”booking-related”></a>
 
 ##### Booking related
 
@@ -435,7 +435,7 @@ All Booking related callbacks receive a <em>single obejct</em> as argument conta
 
 Additionally, `createBookingFailed` and `createBookingSuccessfull` also have a RTKQ `response` object in their respective argument. See [here](https://redux-toolkit.js.org/rtk-query/usage-with-typescript#type-safe-error-handling) for a reference.
 
-<a name=”cancelation_related”></a>
+<a name=”cancelation-related”></a>
 
 ##### Cancelation Related
 
@@ -453,7 +453,7 @@ Additionally, `cancelationSuccessful` and `cancelationFailed` also have a RTKQ r
 
 ##### Dialog related
 
-In addition to the dialog related callbacks already mentioned in [Cancelation Related](#cancelation_related) and [Booking related](#booking_related), there a callbacks for all other dialogs as well.
+In addition to the dialog related callbacks already mentioned in [Cancelation Related](#cancelation-related) and [Booking related](#booking-related), there a callbacks for all other dialogs as well.
 
 - `openedProductSelection`
 - `openedResourceSelection`
@@ -464,7 +464,7 @@ In addition to the dialog related callbacks already mentioned in [Cancelation Re
 
 These do not receive any parameters.
 
-<a name=”data_fetching_related”></a>
+<a name=”data-fetching-related”></a>
 
 ##### Data Fetching Related
 
@@ -797,13 +797,13 @@ Type `select`:
 Here is an example tying all of the aforementioned concepts together.
 And [here](https://jsfiddle.net/timum/wov6pLk7/) is a fiddle containing the very example detailed in this chapter.
 
-<a name=”the_scenario”></a>
+<a name=”the-scenario”></a>
 
 #### The Scenario
 
 It is necessary to determine the gender of customers for a specific purpose. The `mobile` and `message` fields are not necessary and will be removed. The new `gender` field must be filled, therefore a validation check is required to ensure it is completed. Both the name of the `gender` field and the validation messages must be translated into different languages.
 
-<a name=”the_implementation”></a>
+<a name=”the-implementation”></a>
 
 #### The Implementation