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
property
The The data
can be structured in two main ways: as an array, or as an object. 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>],disabled: true,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>],disabled: true,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 |
disabled | boolean | (optional) Disables the list item from selection |
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 a generated 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: CONTENTdisabled?: booleanselectedKey?: 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.