Properties
You may check out the DrawerList Properties down below as well as the Data structure examples.
Property | Type | Description |
---|---|---|
mode | string | (optional) If set to async , it prevents showing the "no options" message during typing / filtering. Defaults to sync . |
input_value | string | (optional) Lets you define a custom input value. |
placeholder | string | (optional) Use this to define the pre-filled placeholder text in the input. Defaults to title="Skriv og velg" . |
title | React.Node | (optional) Give a title to let the user know what they have to do. Defaults to Skriv og få alternativer . |
disable_filter | boolean | (optional) If set to true , word highlighting will still be active, but no options will be filtered out. Defaults to false . |
disable_highlighting | boolean | (optional) If set to true , word highlighting will be disabled, but the options will still get filtered. Defaults to false . |
disable_reorder | boolean | (optional) If set to true , reordering of search results will be disabled. Defaults to false . |
search_numbers | boolean | (optional) If set to true and search_in_word_index is not set, the user will be able to more easily search and filter e.g. bank account numbers. Defaults to false . |
search_in_word_index | boolean | (optional) This gives you the possibility to change the threshold number, which defines from what word on we search "inside words". Defaults to 3 . |
keep_value | boolean | (optional) Use true to not remove the typed value on input blur, if it is invalid. By default, the typed value will disappear / replaced by a selected value from the data list during the input field blur. Defaults to false . |
keep_selection | boolean | (optional) Use true to not remove selected item on input blur, when the input value is empty. Defaults to false . |
keep_value_and_selection | boolean | (optional) Like keep_value – but would not reset to the selected value during input field blur. Also, the selected value would still be kept. Defaults to false . |
prevent_selection | boolean | (optional) If set to true , no permanent selection will be made. Also, the typed value will not disappear on input blur (like keep_value ). Defaults to false . |
show_clear_button | boolean | (optional) If set to true , a clear button is shown inside the input field. Defaults to false . |
icon | string React.Node | (optional) To be included in the autocomplete input. |
icon_size | string | (optional) Change the size of the icon pragmatically. |
icon_position | string | (optional) Position of the icon inside the autocomplete. Set to left or right . Defaults to left . |
input_icon | string React.Node | (optional) Same as icon . |
triangle_position | string | (optional) Position of icon arrow / triangle the drawer. Set to left or right . Defaults to left . |
size | string | (optional) Define the height of the Autocomplete. Can be set to small , default , medium and large . Defaults to default . |
drawer_class | string | (optional) Define a custom class for the internal drawer-list. This makes it possible more easily customize the drawer-list style with styled-components and the css style method. Defaults to null . |
show_submit_button | boolean | (optional) Use true to show a Autocomplete button to toggle the DrawerList. Defaults to false . |
align_autocomplete | string | (optional) Use right to change the options alignment direction. Defaults to left . |
no_options | boolean | (optional) Text show in the "no options" item. Defaults to Ingen alternativer . |
aria_live_options | React.Node | (optional) Text read out by screen readers. This way users with screen readers know how many options they got during typing. Defaults to %s alternativer . |
show_all | boolean | (optional) Text that lets a user unravel all the available options. Defaults to Vis alt . |
indicator_label | React.Node | (optional) Text show on indicator "options" item. Defaults to Henter data ... . |
show_options_sr | string | (optional) Only for screen readers. Title of the button to show the suggestions / options. It is always present and when activating, it opens the DrawerList and sets the focus on it. Defaults to Bla gjennom alternativer . |
selected_sr | string | (optional) Only for screen readers (VoiceOver). The label used to announce the selected item. Defaults to Valgt: . |
submit_button_title | React.Node | (optional) Title on submit button. Defaults to Vis alternativer . |
submit_button_icon | string React.Element | (optional) The icon used in the submit button. Defaults to chevron_down . |
submit_element | React.Node | (optional) Replace the dropdown / submit button with a custom React element. Defaults to the input SubmitButton import { SubmitButton } from '@dnb/eufemia/components/input/Input' . |
opened | boolean | (optional) If set to true , the Autocomplete will be rendered initially with a visible and accessible data list / options. |
open_on_focus | boolean | (optional) Use true to auto open the list once the user is entering the input field with the keyboard. |
stretch | boolean | (optional) If set to true , then the autocomplete will be 100% in available width . |
skip_portal | string | (optional) Set to true to disable the React Portal behavior. Defaults to false . |
status | string | (optional) Text with a status message. The style defaults to an error message. You can use true to only get the status color, without a message. |
status_state | string | (optional) Defines the state of the status. Currently, there are two statuses [error, info] . Defaults to error . |
status_props | object | (optional) Use an object to define additional FormStatus properties. |
globalStatus | object | (optional) The configuration used for the target GlobalStatus. |
label | React.Node | (optional) Prepends the Form Label component. If no ID is provided, a random ID is created. |
label_direction | React.Node | (optional) Use label_direction="vertical" to change the label layout direction. Defaults to horizontal . |
label_sr_only | boolean | (optional) Use true to make the label only readable by screen readers. |
suffix | React.Node | (optional) Text describing the content of the Autocomplete more than the label. You can also send in a React component, so it gets wrapped inside the Autocomplete component. |
skeleton | boolean | (optional) If set to true , an overlaying skeleton with animation will be shown. |
input_ref | React.Ref | (optional) Use a React.Ref to get access to the input DOM element. |
input_element | string React.Element | (optional) Lets you provide a custom React element as the input HTML element. |
DrawerList | Various | (optional) all DrawerList properties. |
Space | string object | (optional) Spacing properties like top or bottom are supported. |
DrawerList Properties
Property | Type | Description |
---|---|---|
data | {DATA} () => {DATA} | (required) The data we want to fill the list with. Details on the type of {DATA} can be found below. The data can be provided as an array or object. Or as a function that returns the data (called when user opens the list). |
value | string number | (optional) Define a preselected data entry. In order of priority, value can be set to: object key (if data is an object), selectedKey prop (if data is an array), array index (if no selectedKey ) or content (if value is a non-integer string). |
default_value | number | (optional) Define a startup value or handle a re-render without handling the state during the re-render by yourself. Defaults to null. |
triangle_position | string | (optional) Position of the arrow icon/triangle inside the drawer-list. Set to 'left' or 'right'. Defaults to 'left' if not set. |
direction | string | (optional) Defines the direction of how the drawer-list shows the options list. Can be 'bottom' or 'top'. Defaults to 'auto'. |
label_direction | string | (optional) The direction of the label. If set to 'horizontal', the label will be positioned horizontally next to the input element. If set to 'vertical', the label will be positioned vertically above the input element. |
prevent_selection | boolean | (optional) If set to true , the DrawerList will then not make any permanent selection. |
focusable | boolean | (optional) If set to true , the element is then focusable by assertive technologies. |
prevent_close | boolean | (optional) If set to true , the DrawerList will not close on any events. |
keep_open | boolean | (optional) If set to true , the DrawerList will close on outside clicks, but not on selection. |
independent_width | boolean | (optional) If set to true , the DrawerList will handle its width and position independently of the parent/mother element. |
fixed_position | boolean | (optional) If set to true , the DrawerList will be fixed in its scroll position by using CSS position: fixed; . |
enable_body_lock | boolean | (optional) If set to true , the HTML body will get locked from scrolling when the Dropdown is open. |
skip_keysearch | boolean | (optional) If set to true , search items by the first key will be ignored. |
ignore_events | boolean | (optional) If set to true , all keyboard and mouse events will be ignored. |
align_drawer | string | (optional) Use 'right' to change the options alignment direction. Makes only sense to use in combination with prevent_selection or more_menu - or if an independent width is used. |
list_class | string | (optional) Define an HTML class that will be set on the list, beside dnb-drawer-list__list . |
portal_class | string | (optional) Define an HTML class that will be set on the DOM portal beside dnb-drawer-list__portal__style . Can be useful to handle e.g. a custom z-index in relation to a header. |
scrollable | boolean | (optional) Defines if the options list should be scrollable (the max-height is set by default to 50vh ). |
no_scroll_animation | boolean | (optional) To disable scrolling animation. |
no_animation | boolean | (optional) To disable appear/disappear (show/hide) animation. |
skip_portal | boolean | (optional) To disable the React Portal behavior. |
min_height | string | (optional) Defines the minimum height (in rem ) of the options list. |
max_height | string | (optional) Defines the maximum height (in rem ) of the options list. |
page_offset | string | (optional) Defines the available scrollable height. If scrolling should not change the height of the drawer-list, then set it to 0 (useful if the DrawerList is used in fixed positions on contrast to a scrollable page content). |
observer_element | string | (optional) Set a HTML element, either as a selector or a DOM element. Can be used to send in an element which will be used to make the direction calculation on. |
cache_hash | string | (optional) Set a cache_hash as a string to enable internal memorizing of the list to enhance rerendering performance. Components like Autocomplete are using this because of the huge data changes due to search and reorder. |
wrapper_element | HTMLElement | (optional) Has to be an HTML Element, ideally a mother element, used to calculate sizes and distances. Also used for the 'click outside' detection. Clicking on the wrapper_element will not trigger an outside click. |
options_render | function | (optional) Has to be a function, returning the items again. See example. This can be used to add additional options above the actual rendered list. |
Space | string object | (optional) Spacing properties like top or bottom are supported. |
data
Prop The data
can be structured in two main ways: as an object, or as an array. An array is preferred as it gives you the most options.
data
as an array
// an array can contain complex items and offers the most controlconst data = [{content: "Item 1",},{content: <span>Item 2</span>},{content: ["Item 3", "Line 2", <span>Line 3</span>]},{content: ['Main account', '1234 12 12345'],selected_value: 'Main account (605,22 kr)',suffix_value: '605,22 kr',},{content: ['Old account', <i>Closed</i>],suffix_value: '0,00 kr',},]// If you only use the `content` property, you can use it directly in the array.// This list is identical to the one above:const data = ["Item 1",<span>Item 2</span>,["Item 3", "Line 2", <span>Line 3</span>],{content: ['Main account', '1234 12 12345'],selected_value: 'Main account (605,22 kr)',suffix_value: '605,22 kr',},{content: ['Old account', <i>Closed</i>],suffix_value: '0,00 kr',},]const onChange = ({ data, value }) => {console.log(data) // returns the item as it appears in the arrayconsole.log(value) // returns the index of the item}
Each object in the array have the following properties:
Property | Type | Description |
---|---|---|
content | string React.node (string | React.Node)[] | (optional) Visual content in the list item |
selectedKey | string number | (optional) If set, can be used instead of array index by the value prop |
selected_value | string React.Node | (optional) Replaces the standard value output for selected item. Only used in some implementations (Dropdown, Autocomplete). |
suffix_value | string React.node | (optional) Content placed to the right in the list item. |
selected_key | string number | (deprecated) Use prop selectedKey instead |
data
as an object
A simpler alternative, but with less options
// Each entry can contain the same type of value as the array's `content` propertyconst data = {first: "Item 1",,second: <span>Item 2</span>,last: ["Item 3", "Line 2", <span>Line 3</span>],}const onChange = ({ data, value }) => {console.log(data) // returns an object representing the item:// {// selectedKey: 'first',// value: 'first',// content: 'Item 1',// type: 'object'// }console.log(value) // returns the key ("first", "second", or "last"), instead of an index}
data
types overview
The following is an overview of all the types that the data
prop accepts. (These are not actual names of actual types in the library.)
// The visual content that is shown in one DrawerList item.// An array can be used to define multiple lines.type CONTENT = string | React.Node | (string | React.Node)[]// An array itemtype ARRAY_OBJECT = {content: CONTENTselectedKey?: string | numberselected_value?: string | React.Nodesuffix_value?: string | React.Node}// `data` as an array. A list of "ARRAY_OBJECT" types is preferred,// but the "CONTENT" type can be useful for simple lists.type ARRAY = (CONTENT | ARRAY_OBJECT)[]// `data` as an object. Can only contain the "CONTENT" type.// Each `key` behaves like the "ARRAY_OBJECT"'s `selectedKey`.type RECORD = Record<string, CONTENT>// An object or array that represents the entire DrawerList list.type DATA = ARRAY | RECORD// The final type of the `data` prop:let data: DATA | () => DATA
JSON string
There is technically support for sending in a JSON string of the data to the data
prop. But this is an old functionality that we do not really support anymore.
Translations
More info about translations can be found in the general localization and Eufemia Forms localization docs.
Key | nb-NO | en-GB |
---|---|---|
Autocomplete.title | Skriv og velg | Type and select |
Autocomplete.submit_button_title | Vis alternativer | Show options |
Autocomplete.no_options | Ingen alternativer | No option |
Autocomplete.show_all | Vis alt | Show everything |
Autocomplete.show_options_sr | Bla gjennom alternativer, lukk med esc knappen | Browse options, close with esc button |
Autocomplete.aria_live_options | %s alternativer | %s options |
Autocomplete.selected_sr | Valgt: | Selected: |
Autocomplete.indicator_label | Henter data ... | Getting data ... |