@aws-amplify/ui-react 4.6.4 → 5.0.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.
Files changed (204) hide show
  1. package/dist/esm/PrimitiveCatalog.mjs +1 -1
  2. package/dist/esm/components/AccountSettings/ChangePassword/ChangePassword.mjs +1 -1
  3. package/dist/esm/components/index.mjs +1 -1
  4. package/dist/esm/index.mjs +1 -1
  5. package/dist/esm/primitives/Autocomplete/AutocompleteMenu.mjs +1 -1
  6. package/dist/esm/primitives/Autocomplete/AutocompleteOption.mjs +1 -1
  7. package/dist/esm/primitives/Link/Link.mjs +1 -1
  8. package/dist/esm/version.mjs +1 -1
  9. package/dist/index.js +1 -1
  10. package/dist/internal.js +1 -1
  11. package/dist/styles.css +0 -378
  12. package/dist/types/components/AccountSettings/types.d.ts +4 -7
  13. package/dist/types/components/index.d.ts +0 -2
  14. package/dist/types/primitives/Alert/Alert.d.ts +2 -3
  15. package/dist/types/primitives/Autocomplete/Autocomplete.d.ts +2 -3
  16. package/dist/types/primitives/Autocomplete/AutocompleteMenu.d.ts +2 -2
  17. package/dist/types/primitives/Autocomplete/AutocompleteOption.d.ts +2 -2
  18. package/dist/types/primitives/Badge/Badge.d.ts +2 -3
  19. package/dist/types/primitives/Button/Button.d.ts +2 -3
  20. package/dist/types/primitives/ButtonGroup/ButtonGroup.d.ts +2 -3
  21. package/dist/types/primitives/Card/Card.d.ts +2 -3
  22. package/dist/types/primitives/Checkbox/Checkbox.d.ts +3 -3
  23. package/dist/types/primitives/CheckboxField/CheckboxField.d.ts +2 -3
  24. package/dist/types/primitives/Collection/Collection.d.ts +2 -2
  25. package/dist/types/primitives/Divider/Divider.d.ts +2 -3
  26. package/dist/types/primitives/Expander/Expander.d.ts +3 -3
  27. package/dist/types/primitives/Expander/ExpanderItem.d.ts +3 -3
  28. package/dist/types/primitives/Field/Field.d.ts +3 -4
  29. package/dist/types/primitives/Field/FieldClearButton.d.ts +2 -3
  30. package/dist/types/primitives/Field/FieldDescription.d.ts +2 -2
  31. package/dist/types/primitives/Field/FieldErrorMessage.d.ts +2 -2
  32. package/dist/types/primitives/FieldGroup/FieldGroup.d.ts +2 -3
  33. package/dist/types/primitives/FieldGroupIcon/FieldGroupIcon.d.ts +2 -3
  34. package/dist/types/primitives/FieldGroupIcon/FieldGroupIconButton.d.ts +2 -3
  35. package/dist/types/primitives/Flex/Flex.d.ts +2 -3
  36. package/dist/types/primitives/Grid/Grid.d.ts +2 -3
  37. package/dist/types/primitives/Heading/Heading.d.ts +2 -5
  38. package/dist/types/primitives/HighlightMatch/HighlightMatch.d.ts +2 -3
  39. package/dist/types/primitives/Icon/Icon.d.ts +2 -3
  40. package/dist/types/primitives/Image/Image.d.ts +2 -3
  41. package/dist/types/primitives/Input/Input.d.ts +2 -3
  42. package/dist/types/primitives/Label/Label.d.ts +2 -3
  43. package/dist/types/primitives/Link/Link.d.ts +2 -3
  44. package/dist/types/primitives/Loader/Loader.d.ts +3 -3
  45. package/dist/types/primitives/Menu/Menu.d.ts +2 -3
  46. package/dist/types/primitives/Menu/MenuButton.d.ts +2 -8
  47. package/dist/types/primitives/Menu/MenuItem.d.ts +2 -6
  48. package/dist/types/primitives/Pagination/Pagination.d.ts +2 -3
  49. package/dist/types/primitives/Pagination/PaginationItem.d.ts +2 -2
  50. package/dist/types/primitives/PasswordField/PasswordField.d.ts +2 -3
  51. package/dist/types/primitives/PasswordField/ShowPasswordButton.d.ts +2 -3
  52. package/dist/types/primitives/PhoneNumberField/CountryCodeSelect.d.ts +2 -3
  53. package/dist/types/primitives/PhoneNumberField/PhoneNumberField.d.ts +2 -3
  54. package/dist/types/primitives/Placeholder/Placeholder.d.ts +2 -3
  55. package/dist/types/primitives/Radio/Radio.d.ts +2 -3
  56. package/dist/types/primitives/RadioGroupField/RadioGroupField.d.ts +2 -3
  57. package/dist/types/primitives/Rating/Rating.d.ts +2 -3
  58. package/dist/types/primitives/ScrollView/ScrollView.d.ts +2 -3
  59. package/dist/types/primitives/SearchField/SearchField.d.ts +2 -3
  60. package/dist/types/primitives/SearchField/SearchFieldButton.d.ts +2 -3
  61. package/dist/types/primitives/Select/Select.d.ts +3 -3
  62. package/dist/types/primitives/SelectField/SelectField.d.ts +2 -3
  63. package/dist/types/primitives/SliderField/SliderField.d.ts +3 -4
  64. package/dist/types/primitives/StepperField/StepperField.d.ts +3 -3
  65. package/dist/types/primitives/StepperField/useStepper.d.ts +1 -1
  66. package/dist/types/primitives/SwitchField/SwitchField.d.ts +2 -3
  67. package/dist/types/primitives/Table/Table.d.ts +2 -3
  68. package/dist/types/primitives/Table/TableBody.d.ts +2 -3
  69. package/dist/types/primitives/Table/TableCell.d.ts +2 -3
  70. package/dist/types/primitives/Table/TableFoot.d.ts +2 -3
  71. package/dist/types/primitives/Table/TableHead.d.ts +2 -3
  72. package/dist/types/primitives/Table/TableRow.d.ts +2 -3
  73. package/dist/types/primitives/Tabs/Tabs.d.ts +3 -4
  74. package/dist/types/primitives/Text/Text.d.ts +2 -3
  75. package/dist/types/primitives/TextArea/TextArea.d.ts +3 -3
  76. package/dist/types/primitives/TextAreaField/TextAreaField.d.ts +3 -3
  77. package/dist/types/primitives/TextField/TextField.d.ts +2 -3
  78. package/dist/types/primitives/ToggleButton/ToggleButton.d.ts +2 -3
  79. package/dist/types/primitives/ToggleButtonGroup/ToggleButtonGroup.d.ts +2 -3
  80. package/dist/types/primitives/View/View.d.ts +2 -7
  81. package/dist/types/primitives/VisuallyHidden/VisuallyHidden.d.ts +2 -3
  82. package/dist/types/primitives/shared/styleUtils.d.ts +3 -3
  83. package/dist/types/primitives/types/alert.d.ts +4 -2
  84. package/dist/types/primitives/types/autocomplete.d.ts +8 -5
  85. package/dist/types/primitives/types/badge.d.ts +3 -2
  86. package/dist/types/primitives/types/base.d.ts +5 -0
  87. package/dist/types/primitives/types/button.d.ts +3 -2
  88. package/dist/types/primitives/types/buttonGroup.d.ts +5 -3
  89. package/dist/types/primitives/types/card.d.ts +3 -2
  90. package/dist/types/primitives/types/checkbox.d.ts +5 -3
  91. package/dist/types/primitives/types/checkboxField.d.ts +5 -3
  92. package/dist/types/primitives/types/collection.d.ts +26 -13
  93. package/dist/types/primitives/types/divider.d.ts +3 -2
  94. package/dist/types/primitives/types/expander.d.ts +5 -3
  95. package/dist/types/primitives/types/field.d.ts +12 -7
  96. package/dist/types/primitives/types/fieldGroup.d.ts +4 -2
  97. package/dist/types/primitives/types/fieldGroupIcon.d.ts +6 -4
  98. package/dist/types/primitives/types/flex.d.ts +3 -2
  99. package/dist/types/primitives/types/grid.d.ts +3 -2
  100. package/dist/types/primitives/types/heading.d.ts +5 -2
  101. package/dist/types/primitives/types/highlightMatch.d.ts +3 -2
  102. package/dist/types/primitives/types/icon.d.ts +3 -2
  103. package/dist/types/primitives/types/image.d.ts +3 -2
  104. package/dist/types/primitives/types/input.d.ts +3 -2
  105. package/dist/types/primitives/types/label.d.ts +3 -2
  106. package/dist/types/primitives/types/link.d.ts +8 -16
  107. package/dist/types/primitives/types/loader.d.ts +3 -2
  108. package/dist/types/primitives/types/menu.d.ts +7 -4
  109. package/dist/types/primitives/types/pagination.d.ts +6 -7
  110. package/dist/types/primitives/types/passwordField.d.ts +7 -4
  111. package/dist/types/primitives/types/phoneNumberField.d.ts +8 -5
  112. package/dist/types/primitives/types/placeholder.d.ts +3 -2
  113. package/dist/types/primitives/types/radio.d.ts +4 -2
  114. package/dist/types/primitives/types/radioGroupField.d.ts +5 -3
  115. package/dist/types/primitives/types/rating.d.ts +4 -2
  116. package/dist/types/primitives/types/scrollView.d.ts +3 -2
  117. package/dist/types/primitives/types/searchField.d.ts +6 -3
  118. package/dist/types/primitives/types/select.d.ts +3 -2
  119. package/dist/types/primitives/types/selectField.d.ts +5 -3
  120. package/dist/types/primitives/types/sliderField.d.ts +4 -3
  121. package/dist/types/primitives/types/stepperField.d.ts +4 -2
  122. package/dist/types/primitives/types/switchField.d.ts +5 -3
  123. package/dist/types/primitives/types/table.d.ts +13 -8
  124. package/dist/types/primitives/types/tabs.d.ts +6 -3
  125. package/dist/types/primitives/types/text.d.ts +3 -7
  126. package/dist/types/primitives/types/textArea.d.ts +3 -2
  127. package/dist/types/primitives/types/textAreaField.d.ts +5 -3
  128. package/dist/types/primitives/types/textField.d.ts +7 -5
  129. package/dist/types/primitives/types/toggleButton.d.ts +4 -2
  130. package/dist/types/primitives/types/toggleButtonGroup.d.ts +5 -3
  131. package/dist/types/primitives/types/view.d.ts +14 -30
  132. package/dist/types/primitives/types/visuallyHidden.d.ts +3 -2
  133. package/dist/types/version.d.ts +1 -1
  134. package/package.json +1 -21
  135. package/dist/esm/components/Geo/LocationSearch/index.mjs +0 -1
  136. package/dist/esm/components/Geo/MapView/index.mjs +0 -1
  137. package/dist/esm/components/InAppMessaging/Backdrop/Backdrop.mjs +0 -1
  138. package/dist/esm/components/InAppMessaging/Backdrop/withBackdrop.mjs +0 -1
  139. package/dist/esm/components/InAppMessaging/BannerMessage/BannerMessage.mjs +0 -1
  140. package/dist/esm/components/InAppMessaging/BannerMessage/constants.mjs +0 -1
  141. package/dist/esm/components/InAppMessaging/CloseIconButton/CloseIconButton.mjs +0 -1
  142. package/dist/esm/components/InAppMessaging/FullScreenMessage/FullScreenMessage.mjs +0 -1
  143. package/dist/esm/components/InAppMessaging/FullScreenMessage/constants.mjs +0 -1
  144. package/dist/esm/components/InAppMessaging/InAppMessageDisplay/InAppMessageDisplay.mjs +0 -1
  145. package/dist/esm/components/InAppMessaging/InAppMessageDisplay/handleMessageLinkAction.mjs +0 -1
  146. package/dist/esm/components/InAppMessaging/InAppMessagingProvider/InAppMessagingProvider.mjs +0 -1
  147. package/dist/esm/components/InAppMessaging/MessageLayout/MessageLayout.mjs +0 -1
  148. package/dist/esm/components/InAppMessaging/MessageLayout/constants.mjs +0 -1
  149. package/dist/esm/components/InAppMessaging/MessageLayout/utils.mjs +0 -1
  150. package/dist/esm/components/InAppMessaging/ModalMessage/ModalMessage.mjs +0 -1
  151. package/dist/esm/components/InAppMessaging/ModalMessage/constants.mjs +0 -1
  152. package/dist/esm/components/InAppMessaging/hooks/useMessageImage/types.mjs +0 -1
  153. package/dist/esm/components/InAppMessaging/hooks/useMessageImage/useMessageImage.mjs +0 -1
  154. package/dist/esm/components/InAppMessaging/hooks/useMessageProps/useMessageProps.mjs +0 -1
  155. package/dist/esm/components/InAppMessaging/hooks/useMessageProps/utils.mjs +0 -1
  156. package/dist/esm/components/InAppMessaging/useInAppMessaging/useInAppMessaging.mjs +0 -1
  157. package/dist/esm/components/InAppMessaging/withInAppMessaging/withInAppMessaging.mjs +0 -1
  158. package/dist/types/components/Geo/LocationSearch/index.d.ts +0 -25
  159. package/dist/types/components/Geo/MapView/index.d.ts +0 -24
  160. package/dist/types/components/Geo/index.d.ts +0 -2
  161. package/dist/types/components/Geo/types/maplibre-gl-geocoder.d.ts +0 -171
  162. package/dist/types/components/InAppMessaging/Backdrop/Backdrop.d.ts +0 -4
  163. package/dist/types/components/InAppMessaging/Backdrop/index.d.ts +0 -2
  164. package/dist/types/components/InAppMessaging/Backdrop/types.d.ts +0 -8
  165. package/dist/types/components/InAppMessaging/Backdrop/withBackdrop.d.ts +0 -3
  166. package/dist/types/components/InAppMessaging/BannerMessage/BannerMessage.d.ts +0 -3
  167. package/dist/types/components/InAppMessaging/BannerMessage/constants.d.ts +0 -1
  168. package/dist/types/components/InAppMessaging/BannerMessage/index.d.ts +0 -2
  169. package/dist/types/components/InAppMessaging/BannerMessage/types.d.ts +0 -7
  170. package/dist/types/components/InAppMessaging/CloseIconButton/CloseIconButton.d.ts +0 -3
  171. package/dist/types/components/InAppMessaging/CloseIconButton/index.d.ts +0 -1
  172. package/dist/types/components/InAppMessaging/CloseIconButton/types.d.ts +0 -8
  173. package/dist/types/components/InAppMessaging/FullScreenMessage/FullScreenMessage.d.ts +0 -3
  174. package/dist/types/components/InAppMessaging/FullScreenMessage/constants.d.ts +0 -1
  175. package/dist/types/components/InAppMessaging/FullScreenMessage/index.d.ts +0 -2
  176. package/dist/types/components/InAppMessaging/FullScreenMessage/types.d.ts +0 -4
  177. package/dist/types/components/InAppMessaging/InAppMessageDisplay/InAppMessageDisplay.d.ts +0 -10
  178. package/dist/types/components/InAppMessaging/InAppMessageDisplay/handleMessageLinkAction.d.ts +0 -3
  179. package/dist/types/components/InAppMessaging/InAppMessageDisplay/index.d.ts +0 -2
  180. package/dist/types/components/InAppMessaging/InAppMessageDisplay/types.d.ts +0 -23
  181. package/dist/types/components/InAppMessaging/InAppMessagingProvider/InAppMessagingProvider.d.ts +0 -4
  182. package/dist/types/components/InAppMessaging/InAppMessagingProvider/index.d.ts +0 -1
  183. package/dist/types/components/InAppMessaging/MessageLayout/MessageLayout.d.ts +0 -3
  184. package/dist/types/components/InAppMessaging/MessageLayout/constants.d.ts +0 -16
  185. package/dist/types/components/InAppMessaging/MessageLayout/index.d.ts +0 -1
  186. package/dist/types/components/InAppMessaging/MessageLayout/types.d.ts +0 -23
  187. package/dist/types/components/InAppMessaging/MessageLayout/utils.d.ts +0 -13
  188. package/dist/types/components/InAppMessaging/ModalMessage/ModalMessage.d.ts +0 -3
  189. package/dist/types/components/InAppMessaging/ModalMessage/constants.d.ts +0 -2
  190. package/dist/types/components/InAppMessaging/ModalMessage/index.d.ts +0 -2
  191. package/dist/types/components/InAppMessaging/ModalMessage/types.d.ts +0 -4
  192. package/dist/types/components/InAppMessaging/hooks/index.d.ts +0 -2
  193. package/dist/types/components/InAppMessaging/hooks/useMessageImage/index.d.ts +0 -1
  194. package/dist/types/components/InAppMessaging/hooks/useMessageImage/types.d.ts +0 -10
  195. package/dist/types/components/InAppMessaging/hooks/useMessageImage/useMessageImage.d.ts +0 -9
  196. package/dist/types/components/InAppMessaging/hooks/useMessageProps/index.d.ts +0 -2
  197. package/dist/types/components/InAppMessaging/hooks/useMessageProps/types.d.ts +0 -39
  198. package/dist/types/components/InAppMessaging/hooks/useMessageProps/useMessageProps.d.ts +0 -11
  199. package/dist/types/components/InAppMessaging/hooks/useMessageProps/utils.d.ts +0 -23
  200. package/dist/types/components/InAppMessaging/index.d.ts +0 -7
  201. package/dist/types/components/InAppMessaging/useInAppMessaging/index.d.ts +0 -1
  202. package/dist/types/components/InAppMessaging/useInAppMessaging/useInAppMessaging.d.ts +0 -3
  203. package/dist/types/components/InAppMessaging/withInAppMessaging/index.d.ts +0 -1
  204. package/dist/types/components/InAppMessaging/withInAppMessaging/withInAppMessaging.d.ts +0 -5
@@ -1,171 +0,0 @@
1
- export type LocationSearchProps = {
2
- /**
3
- * A bounding box given as an array in the format `[minX, minY, maxX, maxY]`.
4
- * Search results will be limited to the bounding box.
5
- */
6
- bbox?: number[];
7
- /**
8
- * Default: false
9
- * If `true`, the LocationSearch control will clear it's contents and blur when user presses the escape key.
10
- */
11
- clearAndBlurOnEsc?: boolean;
12
- /**
13
- * Default: false
14
- * If `true`, the LocationSearch control will clear its value when the input blurs.
15
- */
16
- clearOnBlur?: boolean;
17
- /**
18
- * Default: false
19
- * If `true`, the LocationSearch control will collapse until hovered or in focus.
20
- */
21
- collapsed?: boolean;
22
- /**
23
- * a comma separated list of country codes to limit results to specified country or countries.
24
- */
25
- countries?: string;
26
- /**
27
- * Default: 200
28
- * Sets the amount of time, in milliseconds, to wait before querying the server when a user types into the LocationSearch
29
- * input box. This parameter may be useful for reducing the total number of API calls made for a single query.
30
- */
31
- debounceSearch?: number;
32
- /**
33
- * Default: true
34
- * Allow Maplibre to collect anonymous usage statistics from the plugin.
35
- */
36
- enableEventLogging?: boolean;
37
- /**
38
- * A function accepting the query string, current features list, and LocationSearch options which performs geocoding to
39
- * supplement results from the Maplibre Geocoding API. Expected to return a Promise which resolves to an Array of
40
- * GeoJSON Features in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) format.
41
- */
42
- externalGeocoder?: Function;
43
- /**
44
- * Default: true
45
- * If `false`, animating the map to a selected result is disabled. If `true`, animating the map will use the default
46
- * animation parameters. If an object, it will be passed as `options` to the map [`flyTo`](https://maplibre.org/maplibre-gl-js-docs/api/map/#map#flyto)
47
- * or [`fitBounds`](https://maplibre.org/maplibre-gl-js-docs/api/map/#map#fitbounds) method providing control over the animation of the transition.
48
- */
49
- flyTo?: boolean | object;
50
- /**
51
- * A function which accepts a Feature in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) format to filter out
52
- * results from the Geocoding API response before they are included in the suggestions list. Return `true` to keep the item, `false` otherwise.
53
- */
54
- filter?: Function;
55
- /**
56
- * A function that specifies how the selected result should be rendered in the search bar. This function should accept a single [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) object as input and return a string.
57
- * HTML tags in the output string will not be rendered. Defaults to `(item) => item.place_name`.
58
- */
59
- getItemValue?: Function;
60
- /**
61
- * Specify the language to use for response text and query result weighting. Options are IETF language tags comprised
62
- * of a mandatory ISO 639-1 language code and optionally one or more IETF subtags for country or script. More than
63
- * one value can also be specified, separated by commas. Defaults to the browser's language settings.
64
- */
65
- language?: string;
66
- /**
67
- * Default: 5
68
- * Maximum number of results to show.
69
- */
70
- limit?: number;
71
- /**
72
- * A function accepting the query string which performs local geocoding to supplement results from the Maplibre
73
- * Geocoding API. Expected to return an Array of GeoJSON Features in the [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) format.
74
- */
75
- localGeocoder?: Function;
76
- /**
77
- * Default: false
78
- * If `true`, indicates that the `localGeocoder` results should be the only ones returned to the user. If `false`,
79
- * indicates that the `localGeocoder` results should be combined with those from the Maplibre API with the `localGeocoder` results ranked higher.
80
- */
81
- localGeocoderOnly?: boolean;
82
- /**
83
- * Default: { color: '#4668F2' }
84
- * If `true`, a [Marker](https://maplibre.org/maplibre-gl-js-docs/api/markers/#marker) will be added to the map at the location of the user-selected
85
- * result using a default set of Marker options. If the value is an object, the marker will be constructed using these
86
- * options. If `false`, no marker will be added to the map. Requires that `options.maplibregl` also be set (which it is by default).
87
- */
88
- marker?: boolean | object;
89
- /**
90
- * Default: 2
91
- * Minimum number of characters to enter before results are shown.
92
- */
93
- minLength?: number;
94
- /**
95
- * Default: 'Search'
96
- * Override the default placeholder attribute value.
97
- */
98
- placeholder?: string;
99
- /**
100
- * Default: true
101
- * If `true`, a [Popup](https://maplibre.org/maplibre-gl-js-docs/api/markers/#popup) will be added to the map when clicking on a marker using a default set of popup options.
102
- * If the value is an object, the popup will be constructed using these options. If `false`, no popup will be added to the map.
103
- * Requires that `options.maplibregl` also be set (which it is by default).
104
- */
105
- popup?: boolean | object;
106
- /**
107
- * A function that specifies how the results should be rendered in the popup menu. This function should accept a single [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md) object as input and return a string.
108
- * Any HTML in the returned string will be rendered.
109
- */
110
- popupRender?: Function;
111
- /**
112
- * Default: 'top-right'
113
- * Position the LocationSearch will be rendered on the map. Only relevant when `<LocationSearch>` is used with a map.
114
- */
115
- position?: 'bottom-left' | 'bottom-right' | 'top-left' | 'top-right';
116
- /**
117
- * A geographical point given as an object with `latitude` and `longitude`
118
- * properties. Search results closer to this point will be given
119
- * higher priority. Defaults to map viewport if rendered as a map control.
120
- */
121
- proximity?: {
122
- latitude: number;
123
- longitude: number;
124
- };
125
- /**
126
- * A function that specifies how the results should be rendered in the dropdown menu. This function should accepts a single [Carmen GeoJSON](https://github.com/mapbox/carmen/blob/master/carmen-geojson.md)
127
- * object as input and return a string. Any HTML in the returned string will be rendered.
128
- */
129
- render?: Function;
130
- /**
131
- * Default: false
132
- * If `true`, enable reverse geocoding mode. In reverse geocoding, search input is expected to be coordinates in the
133
- * form `lat, lon`, with suggestions being the reverse geocodes.
134
- */
135
- reverseGeocoder?: boolean;
136
- /**
137
- * Default: 'distance'
138
- * Set the factors that are used to sort nearby results.
139
- */
140
- reverseMode?: 'distance' | 'score';
141
- /**
142
- * Default: { color: '#4668F2' }
143
- * If `true`, [Markers](https://maplibre.org/maplibre-gl-js-docs/api/markers/#marker) will be added to the map at the location the top results for the query.
144
- * If the value is an object, the marker will be constructed using these options. If `false`, no marker will be added to the map.
145
- * Requires that `options.maplibregl` also be set (which it is by default).
146
- */
147
- showResultMarkers?: boolean | object;
148
- /**
149
- * Default: true
150
- * If `false`, indicates that search will only occur on enter key press. If `true`, indicates that the LocationSearch will
151
- * search on the input box being updated above the minLength option.
152
- */
153
- showResultsWhileTyping?: boolean;
154
- /**
155
- * Default: true
156
- * If `true`, the LocationSearch proximity will automatically update based on the map view.
157
- */
158
- trackProximity?: boolean;
159
- /**
160
- * A comma separated list of types that filter results to match those specified. See https://docs.mapbox.com/api/search/#data-types
161
- * for available types. If reverseGeocode is enabled, you should specify one type. If you configure more than one type, the first
162
- * type will be used.
163
- */
164
- types?: string;
165
- /**
166
- * Default: 16
167
- * On geocoded result, what zoom level should the map animate to when a `bbox` isn't found in the response.
168
- * If a `bbox` is found the map will fit to the `bbox`.
169
- */
170
- zoom?: number;
171
- };
@@ -1,4 +0,0 @@
1
- /// <reference types="react" />
2
- import { BackdropProps } from './types';
3
- export declare const BACKDROP_TEST_ID = "inappmessaging-backdrop";
4
- export declare function Backdrop({ onClick, ...rest }: BackdropProps): JSX.Element;
@@ -1,2 +0,0 @@
1
- export { Backdrop } from './Backdrop';
2
- export { withBackdrop } from './withBackdrop';
@@ -1,8 +0,0 @@
1
- /// <reference types="react" />
2
- import { ViewProps } from '../../../primitives/types';
3
- export interface BackdropProps extends ViewProps {
4
- /**
5
- * Function called when backdrop is clicked
6
- */
7
- onClick?: React.MouseEventHandler<HTMLDivElement>;
8
- }
@@ -1,3 +0,0 @@
1
- /// <reference types="react" />
2
- import { BackdropProps } from './types';
3
- export declare function withBackdrop<Props>(Content: (props: Props) => JSX.Element, options?: BackdropProps): (props: Props) => JSX.Element;
@@ -1,3 +0,0 @@
1
- /// <reference types="react" />
2
- import { BannerMessageProps } from './types';
3
- export declare function BannerMessage(props: BannerMessageProps): JSX.Element | null;
@@ -1 +0,0 @@
1
- export declare const BLOCK_CLASS = "amplify-inappmessaging-bannermessage";
@@ -1,2 +0,0 @@
1
- export { BannerMessage } from './BannerMessage';
2
- export { BannerMessageProps } from './types';
@@ -1,7 +0,0 @@
1
- import { BannerMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
2
- import { MessageOverrideStyle } from '../hooks';
3
- type BannerMessageAlignment = 'left' | 'center' | 'right';
4
- export interface BannerMessageProps extends BannerMessageCommonProps<MessageOverrideStyle | undefined> {
5
- alignment?: BannerMessageAlignment;
6
- }
7
- export {};
@@ -1,3 +0,0 @@
1
- /// <reference types="react" />
2
- import { CloseIconButtonProps } from './types';
3
- export declare function CloseIconButton({ className, dismissButtonLabel, onClick, style, ...rest }: CloseIconButtonProps): JSX.Element;
@@ -1 +0,0 @@
1
- export { CloseIconButton } from './CloseIconButton';
@@ -1,8 +0,0 @@
1
- import { ButtonProps } from '../../../primitives';
2
- export interface CloseIconButtonProps extends ButtonProps {
3
- /**
4
- * @description
5
- * Configures the accessible label for the close iconButton
6
- */
7
- dismissButtonLabel?: string;
8
- }
@@ -1,3 +0,0 @@
1
- /// <reference types="react" />
2
- import { FullScreenMessageProps } from './types';
3
- export declare function FullScreenMessage(props: FullScreenMessageProps): JSX.Element | null;
@@ -1 +0,0 @@
1
- export declare const BLOCK_CLASS = "amplify-inappmessaging-fullscreenmessage";
@@ -1,2 +0,0 @@
1
- export { FullScreenMessage } from './FullScreenMessage';
2
- export { FullScreenMessageProps } from './types';
@@ -1,4 +0,0 @@
1
- import { FullScreenMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
2
- import { MessageOverrideStyle } from '../hooks';
3
- export interface FullScreenMessageProps extends FullScreenMessageCommonProps<MessageOverrideStyle | undefined> {
4
- }
@@ -1,10 +0,0 @@
1
- /// <reference types="react" />
2
- import { InAppMessageDisplayProps } from './types';
3
- declare function InAppMessageDisplay({ components: overrideComponents, }: InAppMessageDisplayProps): JSX.Element;
4
- declare namespace InAppMessageDisplay {
5
- var BannerMessage: typeof import("../BannerMessage").BannerMessage;
6
- var CarouselMessage: <P>(_: P) => null;
7
- var FullScreenMessage: typeof import("../FullScreenMessage").FullScreenMessage;
8
- var ModalMessage: typeof import("../ModalMessage").ModalMessage;
9
- }
10
- export default InAppMessageDisplay;
@@ -1,3 +0,0 @@
1
- import { HandleMessageLinkAction } from '@aws-amplify/ui-react-core-notifications';
2
- declare const handleMessageLinkAction: HandleMessageLinkAction;
3
- export default handleMessageLinkAction;
@@ -1,2 +0,0 @@
1
- export { default as InAppMessageDisplay } from './InAppMessageDisplay';
2
- export { MessageComponents } from './types';
@@ -1,23 +0,0 @@
1
- import { BannerMessageComponent, CarouselMessageComponent, FullScreenMessageComponent, ModalMessageComponent } from '@aws-amplify/ui-react-core-notifications';
2
- import { BannerMessageProps } from '../BannerMessage';
3
- import { FullScreenMessageProps } from '../FullScreenMessage';
4
- import { ModalMessageProps } from '../ModalMessage';
5
- type BannerStyle = BannerMessageProps['style'];
6
- type CarouselStyle = any;
7
- type FullScreenStyle = FullScreenMessageProps['style'];
8
- type ModalStyle = ModalMessageProps['style'];
9
- export interface MessageDefaultComponents {
10
- BannerMessage: BannerMessageComponent<BannerStyle>;
11
- CarouselMessage: CarouselMessageComponent<CarouselStyle>;
12
- FullScreenMessage: FullScreenMessageComponent<FullScreenStyle>;
13
- ModalMessage: ModalMessageComponent<ModalStyle>;
14
- }
15
- export interface MessageComponents extends Partial<MessageDefaultComponents> {
16
- }
17
- export interface InAppMessageDisplayProps {
18
- /**
19
- * Message override UI components
20
- */
21
- components?: MessageComponents;
22
- }
23
- export {};
@@ -1,4 +0,0 @@
1
- /// <reference types="react" />
2
- import { InAppMessagingProviderProps } from '@aws-amplify/ui-react-core-notifications';
3
- declare function InAppMessagingProvider(props: InAppMessagingProviderProps): JSX.Element;
4
- export default InAppMessagingProvider;
@@ -1 +0,0 @@
1
- export { default as InAppMessagingProvider } from './InAppMessagingProvider';
@@ -1,3 +0,0 @@
1
- /// <reference types="react" />
2
- import { MessageLayoutProps } from './types';
3
- export declare function MessageLayout({ body, buttonSize, hasRenderableImage, header, image, onClose, orientation, primaryButton, secondaryButton, styles, }: MessageLayoutProps): JSX.Element;
@@ -1,16 +0,0 @@
1
- export declare const BLOCK_CLASS = "amplify-inappmessaging-messagelayout";
2
- export declare const BUTTON_CLASS: string;
3
- export declare const CLOSE_BUTTON_CLASS: string;
4
- export declare const CONTENT_CLASS: string;
5
- export declare const HEADER_CLASS: string;
6
- export declare const IMAGE_CONTAINER_CLASS: string;
7
- export declare const TEXT_CONTAINER_CLASS: string;
8
- export declare const BODY_TEXT_TEST_ID = "inappmessaging-messagelayout-bodytext";
9
- export declare const BUTTON_GROUP_TEST_ID = "inappmessaging-messagelayout-buttongroup";
10
- export declare const CONTENT_TEST_ID = "inappmessaging-messagelayout-content";
11
- export declare const HEADER_TEXT_TEST_ID = "inappmessaging-messagelayout-headertext";
12
- export declare const IMAGE_CONTAINER_TEST_ID = "inappmessaging-messagelayout-imagecontainer";
13
- export declare const MESSAGE_LAYOUT_TEST_ID = "inappmessaging-messagelayout";
14
- export declare const PRIMARY_BUTTON_TEST_ID = "inappmessaging-messagelayout-primarybutton";
15
- export declare const SECONDARY_BUTTON_TEST_ID = "inappmessaging-messagelayout-secondarybutton";
16
- export declare const TEXT_CONTAINER_TEST_ID = "inappmessaging-messagelayout-textcontainer";
@@ -1 +0,0 @@
1
- export { MessageLayout } from './MessageLayout';
@@ -1,23 +0,0 @@
1
- import { MessageComponentBaseProps } from '@aws-amplify/ui-react-core-notifications';
2
- import { ButtonProps } from '../../../primitives';
3
- import { MessageComponentStyles, MessageOverrideStyle, UseMessageProps } from '../hooks';
4
- type MessageLayoutOrientation = 'horizontal' | 'vertical';
5
- export type MessageLayoutButtonModifier = 'dark' | 'light';
6
- export interface MessageLayoutProps extends Omit<MessageComponentBaseProps<MessageOverrideStyle>, 'style'>, Omit<UseMessageProps, 'shouldRenderMessage' | 'styles'> {
7
- /**
8
- * @description
9
- * Changes the size of the buttons.
10
- */
11
- buttonSize?: ButtonProps['size'];
12
- /**
13
- * @description
14
- * The orientation determines how message content will be laid out.
15
- */
16
- orientation?: MessageLayoutOrientation;
17
- /**
18
- * @description
19
- * Component styles - typically a combination of payload and override styles.
20
- */
21
- styles: MessageComponentStyles;
22
- }
23
- export {};
@@ -1,13 +0,0 @@
1
- import { MessageComponentStyles } from '../hooks/useMessageProps';
2
- import { MessageLayoutButtonModifier } from './types';
3
- /**
4
- * Utility for determining the class modifier for an In-App Messaging button
5
- * based on its background color
6
- *
7
- * @param buttonStyles button styles which should contain the background color
8
- * @param defaultModifier modifier that should be returned in cases where
9
- * background color is undefined
10
- *
11
- * @returns the modifier - either 'light' or 'dark'
12
- */
13
- export declare const getButtonModifier: (buttonStyles: MessageComponentStyles['primaryButton' | 'primaryButton'], defaultModifier?: MessageLayoutButtonModifier) => MessageLayoutButtonModifier;
@@ -1,3 +0,0 @@
1
- /// <reference types="react" />
2
- import { ModalMessageProps } from './types';
3
- export declare function ModalMessage(props: ModalMessageProps): JSX.Element | null;
@@ -1,2 +0,0 @@
1
- export declare const BLOCK_CLASS = "amplify-inappmessaging-modalmessage";
2
- export declare const DIALOG_CLASS: string;
@@ -1,2 +0,0 @@
1
- export { ModalMessage } from './ModalMessage';
2
- export { ModalMessageProps } from './types';
@@ -1,4 +0,0 @@
1
- import { ModalMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
2
- import { MessageOverrideStyle } from '../hooks';
3
- export interface ModalMessageProps extends ModalMessageCommonProps<MessageOverrideStyle | undefined> {
4
- }
@@ -1,2 +0,0 @@
1
- export { useMessageImage } from './useMessageImage';
2
- export { MessageComponentStyles, MessageOverrideStyle, useMessageProps, UseMessageProps, } from './useMessageProps';
@@ -1 +0,0 @@
1
- export { default as useMessageImage } from './useMessageImage';
@@ -1,10 +0,0 @@
1
- export declare enum ImagePrefetchStatus {
2
- Aborted = "ABORTED",
3
- Failure = "FAILURE",
4
- Fetching = "FETCHING",
5
- Success = "SUCCESS"
6
- }
7
- export type UseMessageImage = {
8
- hasRenderableImage: boolean;
9
- isImageFetching: boolean;
10
- };
@@ -1,9 +0,0 @@
1
- import { MessageImage } from '@aws-amplify/ui-react-core-notifications';
2
- import { UseMessageImage } from './types';
3
- /**
4
- * Handles prefetching for message images
5
- *
6
- * @param image contains image source
7
- * @returns message image dimensions and fetching related booleans
8
- */
9
- export default function useMessageImage(image: MessageImage | undefined): UseMessageImage;
@@ -1,2 +0,0 @@
1
- export { default as useMessageProps } from './useMessageProps';
2
- export { MessageComponentStyles, MessageOverrideStyle, UseMessageProps, } from './types';
@@ -1,39 +0,0 @@
1
- /// <reference types="react" />
2
- import { MessagePayloadStyle } from '@aws-amplify/ui-react-core-notifications';
3
- /**
4
- * Inline style props for message components. Can be overridden by customer
5
- */
6
- export interface MessageComponentStyles {
7
- body: React.CSSProperties;
8
- closeIconButton: React.CSSProperties;
9
- container: React.CSSProperties;
10
- header: React.CSSProperties;
11
- image: React.CSSProperties;
12
- primaryButton: React.CSSProperties;
13
- secondaryButton: React.CSSProperties;
14
- }
15
- export interface UseMessageProps {
16
- hasRenderableImage: boolean;
17
- shouldRenderMessage: boolean;
18
- styles: MessageComponentStyles;
19
- }
20
- export interface MessageStyleParams {
21
- /**
22
- * style params to derive resolved style from
23
- */
24
- styleParams: StyleParams;
25
- }
26
- export interface StyleParams {
27
- /**
28
- * message specific styles in the message payload
29
- */
30
- payloadStyle: MessagePayloadStyle;
31
- /**
32
- * custom component style passed as style prop to message UI components
33
- */
34
- overrideStyle?: MessageOverrideStyle;
35
- }
36
- /**
37
- * Override style props
38
- */
39
- export type MessageOverrideStyle = Partial<MessageComponentStyles>;
@@ -1,11 +0,0 @@
1
- import { MessageComponentBaseProps } from '@aws-amplify/ui-react-core-notifications';
2
- import { MessageOverrideStyle, UseMessageProps } from './types';
3
- /**
4
- * Handle common message UI component prop logic including render booleans, and
5
- * style resolving
6
- *
7
- * @param props message UI component props
8
- *
9
- * @returns message UI component render related booleans and styles
10
- */
11
- export default function useMessageProps(props: MessageComponentBaseProps<MessageOverrideStyle>): UseMessageProps;
@@ -1,23 +0,0 @@
1
- import { MessageComponentBaseProps, MessagePayloadStyle } from '@aws-amplify/ui-react-core-notifications';
2
- import { MessageComponentStyles, MessageStyleParams } from './types';
3
- /**
4
- * Utility for extracting message payload style
5
- *
6
- * @param props message props
7
- *
8
- * @returns message payload-specific styles
9
- */
10
- export declare const getPayloadStyle: ({ body, container, header, primaryButton, secondaryButton, }: MessageComponentBaseProps) => MessagePayloadStyle;
11
- /**
12
- * Receives message styling and returns style property values for use with in-app message
13
- * UI components. Handles resolving style precedence between payload and custom styles
14
- *
15
- * Styles resolve precedence from lowest to highest:
16
- * 1. Payload styles
17
- * 2. Custom (override) styles
18
- *
19
- * @param params message style params
20
- *
21
- * @returns message component styles
22
- */
23
- export declare function getMessageStyles({ styleParams, }: MessageStyleParams): MessageComponentStyles;
@@ -1,7 +0,0 @@
1
- export { BannerMessageProps } from './BannerMessage';
2
- export { FullScreenMessageProps } from './FullScreenMessage';
3
- export { InAppMessageDisplay, MessageComponents } from './InAppMessageDisplay';
4
- export { InAppMessagingProvider } from './InAppMessagingProvider';
5
- export { ModalMessageProps } from './ModalMessage';
6
- export { useInAppMessaging } from './useInAppMessaging';
7
- export { withInAppMessaging } from './withInAppMessaging';
@@ -1 +0,0 @@
1
- export { default as useInAppMessaging } from './useInAppMessaging';
@@ -1,3 +0,0 @@
1
- import { UseInAppMessaging } from '@aws-amplify/ui-react-core-notifications';
2
- declare function useInAppMessaging(): UseInAppMessaging;
3
- export default useInAppMessaging;
@@ -1 +0,0 @@
1
- export { default as withInAppMessaging } from './withInAppMessaging';
@@ -1,5 +0,0 @@
1
- import React from 'react';
2
- import { MessageComponents } from '../InAppMessageDisplay';
3
- export default function withInAppMessaging<Props = {}>(Component: React.ComponentType<Props>, options?: {
4
- components?: MessageComponents;
5
- }): (props: Props) => JSX.Element;