@timum/booking 1.14.6 → 1.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -818,10 +818,12 @@ Anatomy of a custom booking form field:
818
818
  </blockquote>
819
819
  <br>
820
820
  <blockquote>
821
- <code>title</code>: string or JSXElement;
822
- validation: yup based validation. See <a href="https://github.com/jquense/yup">yup docu</a>. Re-exported and accessible via timum.yup
823
-
824
- </blockquote>
821
+ <code>title</code>: string or JSXElement;
822
+ </blockquote>
823
+ <br>
824
+ <blockquote>
825
+ <code>validation</code>: yup based validation. See <a href="https://github.com/jquense/yup">yup docu</a>. Re-exported and accessible via timum.yup
826
+ </blockquote>
825
827
  <br>
826
828
  <blockquote>
827
829
  <code>type</code>: string; either 'text' (default), 'phoneNumber', 'textarea', 'checkbox' or 'select'. Depending on the chosen type additional properties are available. See below.
@@ -855,35 +857,31 @@ Anatomy of a custom booking form field:
855
857
  </blockquote>
856
858
  `}`
857
859
 
858
- fieldName
859
-
860
- - define a field name
861
-
862
860
  Depending on the type there are additional properties you can/must specify:
863
861
 
864
862
  - Type `text`:
865
863
 
866
- - `format`: string; the native input field's 'type' (e.g. 'email', 'number', etc.).
864
+ - `format`: string; the native input field's 'type' (e.g. 'email', 'number', etc.).
867
865
 
868
866
  - Type `phoneNumber`:
869
867
 
870
- - does NOT support `validation`. Phone number validation is complex, so timum handles it for you.
868
+ - does NOT support `validation`. Phone number validation is complex, so timum handles it for you.
871
869
  This does mean that field validation localisation is currently not supported for fields of this type.
872
870
  This will be fixed in a future update.
873
- - isRequired: boolean; if true, this field must be filled with a valid number
874
- - defaultCountry: string, denotes the country code which is preselected when first rendering the component. Default is 'DE',
875
- - preferredCountries: list of strings; denotes which countries are displayed first in the country drop down. Defaults are ['DE', 'CH', 'AT'],
871
+ - <code>isRequired</code>: boolean; if true, this field must be filled with a valid number
872
+ - <code>defaultCountry</code>: string, denotes the country code which is preselected when first rendering the component. Default is 'DE',
873
+ - <code>preferredCountries</code>: list of strings; denotes which countries are displayed first in the country drop down. Defaults are ['DE', 'CH', 'AT'],
876
874
 
877
875
  - Type `textArea`:
878
876
 
879
- - limit: number; sets the maximum number of characters customers can enter.
877
+ - <code>limit</code>: number; sets the maximum number of characters customers can enter. Standard is 1024 characters. Setting this to a higher number leads to error.
880
878
 
881
879
  - Type `checkbox`:
882
- - no special properties.
880
+ - no special properties.
883
881
 
884
- Type `select`:
882
+ - Type `select`:
885
883
 
886
- - options: array of objects with structure { title: string, key: string }. The title is displayed and the key is passed in the data object to callbacks.
884
+ - options: array of objects with structure { title: string, key: string }. The title is displayed and the key is passed in the data object to callbacks.
887
885
 
888
886
  <a name=”custom-field-example”></a>
889
887