add documentation

dnbexperience · Sep 24, 2024 · d0f553a · d0f553a
1 parent f7ef629
commit d0f553a
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 1 deletion.
diff --git a/...ages/dnb-design-system-portal/src/docs/uilib/components/dropdown/properties.mdx b/...ages/dnb-design-system-portal/src/docs/uilib/components/dropdown/properties.mdx
@@ -40,6 +40,7 @@ You may check out the [DrawerList Properties](#drawerlist-properties) down below
 | `innerRef`                                                       | _(optional)_ by providing a React.ref you can get the internally used main element (DOM). E.g. `innerRef={myRef}` by using `React.createRef()` or `React.useRef()`.     |
 | `buttonRef`                                                      | _(optional)_ by providing a React.ref you can get the internally used button element (DOM). E.g. `buttonRef={myRef}` by using `React.createRef()` or `React.useRef()`.  |
 | `skeleton`                                                       | _(optional)_ if set to `true`, an overlaying skeleton with animation will be shown.                                                                                     |
+| `keepSelectIndexOnDataChange`                                    | _(optional)_ Determines if the selection index should be retained between `data` changes or not. Defaults to `false`                                                    |
 | [DrawerList](/uilib/components/fragments/drawer-list/properties) | _(optional)_ all DrawerList properties.                                                                                                                                 |
 | [Space](/uilib/layout/space/properties)                          | _(optional)_ spacing properties like `top` or `bottom` are supported.                                                                                                   |
 

diff --git a/packages/dnb-eufemia/src/components/autocomplete/Autocomplete.d.ts b/packages/dnb-eufemia/src/components/autocomplete/Autocomplete.d.ts
@@ -211,6 +211,9 @@ export interface AutocompleteProps {
    * 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`.
    */
   drawer_class?: string;
+  /**
+   * Determines if the selection index should retain between `data` changes or not. Default: `false`
+   */
   keepSelectIndexOnDataChange?: boolean;
   on_type?: (...args: any[]) => any;
   on_focus?: (...args: any[]) => any;

diff --git a/packages/dnb-eufemia/src/components/autocomplete/AutocompleteDocs.ts b/packages/dnb-eufemia/src/components/autocomplete/AutocompleteDocs.ts
@@ -236,6 +236,11 @@ export const autocompleteProperties: PropertiesTableProps = {
     type: ['string', 'React.Element'],
     status: 'optional',
   },
+  keepSelectIndexOnDataChange: {
+    doc: 'Determines if the selection index should be retained between `data` changes or not. Defaults to `false`',
+    type: 'boolean',
+    status: 'optional',
+  },
   '[DrawerList](/uilib/components/fragments/drawer-list/properties)': {
     doc: 'all DrawerList properties.',
     type: 'Various',

diff --git a/packages/dnb-eufemia/src/components/dropdown/Dropdown.d.ts b/packages/dnb-eufemia/src/components/dropdown/Dropdown.d.ts
@@ -108,7 +108,7 @@ export interface DropdownProps {
   on_show_focus?: (...args: any[]) => any;
   on_hide_focus?: (...args: any[]) => any;
   /**
-   * Resets the select index when data prop changes
+   * Determines if the selection index should retain between `data` changes or not. Default: `false`
    */
   keepSelectIndexOnDataChange?: boolean;
 }

diff --git a/packages/dnb-eufemia/src/fragments/drawer-list/DrawerList.d.ts b/packages/dnb-eufemia/src/fragments/drawer-list/DrawerList.d.ts
@@ -181,6 +181,9 @@ export interface DrawerListProps {
   on_resize?: (...args: any[]) => any;
   on_select?: (...args: any[]) => any;
   on_state_update?: (...args: any[]) => any;
+  /**
+   * Determines if the selection index should retain between `data` changes or not. Default: `false`
+   */
   keepSelectIndexOnDataChange?: boolean;
 }
 export type DrawerListOptionsProps = {

diff --git a/packages/dnb-eufemia/src/fragments/drawer-list/DrawerListDocs.ts b/packages/dnb-eufemia/src/fragments/drawer-list/DrawerListDocs.ts
@@ -146,6 +146,11 @@ export const DrawerListProperties: PropertiesTableProps = {
     type: 'function',
     status: 'optional',
   },
+  keepSelectIndexOnDataChange: {
+    doc: 'Determines if the selection index should be retained between `data` changes or not. Defaults to `false`',
+    type: 'boolean',
+    status: 'optional',
+  },
   '[Space](/uilib/layout/space/properties)': {
     doc: 'Spacing properties like `top` or `bottom` are supported.',
     type: ['string', 'object'],