From 4c9477a8dc90bb8d7b01738b6cc96df88629eb0f Mon Sep 17 00:00:00 2001 From: Anders Date: Thu, 9 Mar 2023 10:22:35 +0100 Subject: [PATCH] docs(GlobalStatus): improve docs for id prop (#2067) --- .../src/docs/uilib/components/global-status/properties.mdx | 4 ++-- .../src/components/global-status/GlobalStatus.d.ts | 2 +- .../src/components/global-status/GlobalStatusController.d.ts | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/dnb-design-system-portal/src/docs/uilib/components/global-status/properties.mdx b/packages/dnb-design-system-portal/src/docs/uilib/components/global-status/properties.mdx index 6113f3a5960..7a347b49fc3 100644 --- a/packages/dnb-design-system-portal/src/docs/uilib/components/global-status/properties.mdx +++ b/packages/dnb-design-system-portal/src/docs/uilib/components/global-status/properties.mdx @@ -6,7 +6,7 @@ showTabs: true | Properties | Description | | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | _(optional)_ the main ID. Defaults to the prop | +| `id` | _(optional)_ the main ID. Defaults to `main`. | | `title` | _(optional)_ the title appears as a part of the status content. Use `false` to hide / remove the title and icon. Defaults to `En feil har skjedd`. | | `text` or `children` | _(optional)_ the text appears as the status content. Besides plain text, you can send in a React component as well. Defaults to `null`. | | `items` | _(optional)_ the items (list items) appear as a part of the status content. you can both use an JSON array, or a vanilla array with a string or an object content. Se **Item Object** example below. | @@ -68,6 +68,6 @@ The goal is to update the content (properties/events) of the target GlobalStatus | Controller Properties | Description | | --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | _(optional)_ the main ID. Defaults to the prop `main`. | +| `id` | _(optional)_ the main ID. Defaults to `main`. | | `status_id` | _(optional)_ define a new stack ID so you can remove it with the same ID later on. Defaults to `null`. | | `remove_on_unmount` | _(optional)_ set to `true` if you want that the component `` should automatically remove the stacked status from the target **GlobalStatus** on component unmount. Defaults to `false`. | diff --git a/packages/dnb-eufemia/src/components/global-status/GlobalStatus.d.ts b/packages/dnb-eufemia/src/components/global-status/GlobalStatus.d.ts index 8ed42e72a7a..02a661ff977 100644 --- a/packages/dnb-eufemia/src/components/global-status/GlobalStatus.d.ts +++ b/packages/dnb-eufemia/src/components/global-status/GlobalStatus.d.ts @@ -23,7 +23,7 @@ export interface GlobalStatusProps extends React.HTMLProps, SpacingProps { /** - * The main ID. Defaults to the prop + * The main ID. Defaults to `main`. */ id?: string; status_id?: string; diff --git a/packages/dnb-eufemia/src/components/global-status/GlobalStatusController.d.ts b/packages/dnb-eufemia/src/components/global-status/GlobalStatusController.d.ts index 28725c667d3..1406a7cc5db 100644 --- a/packages/dnb-eufemia/src/components/global-status/GlobalStatusController.d.ts +++ b/packages/dnb-eufemia/src/components/global-status/GlobalStatusController.d.ts @@ -3,7 +3,7 @@ import * as React from 'react'; export interface GlobalStatusControllerProps extends React.HTMLProps { /** - * The main ID. Defaults to the prop + * The main ID. Defaults to `main`. */ id?: string; status_id?: string; @@ -19,7 +19,7 @@ export default class GlobalStatusController extends React.Component< export interface GlobalStatusRemoveProps { /** - * The main ID. Defaults to the prop + * The main ID. Defaults to `main`. */ id?: string; status_id: string;