fix(forms): rename contents to content

This PR should align the term we already use before in other components. Also, internally used only, we rename `contentsWidth` to `contentWidth`.
dnbexperience · Jan 22, 2024 · 6c1b176 · 6c1b176
1 parent ed115d5
commit 6c1b176
Show file tree

Hide file tree

Showing 33 changed files with 64 additions and 64 deletions.
diff --git a/.../dnb-design-system-portal/src/docs/uilib/extensions/forms/base-fields/Number/Examples.tsx b/.../dnb-design-system-portal/src/docs/uilib/extensions/forms/base-fields/Number/Examples.tsx
@@ -82,7 +82,7 @@ export const WithHelp = () => {
         label="Label text"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Here is what a team can do for you. . . . It allows you to help others do their best.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...system-portal/src/docs/uilib/extensions/forms/base-fields/Number/properties.mdx b/...system-portal/src/docs/uilib/extensions/forms/base-fields/Number/properties.mdx
@@ -25,7 +25,7 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 | `width`                                 | `string` or `false`  | _(optional)_ `false` for no width (use browser default), `small`, `medium` or `large` for predefined standard widths, `stretch` for fill available width.       |
 | `size`                                  | `string` or `number` | _(optional)_ Size of the input field, see Input's properties for available options. Accepts, but will not forward `number` values as input's element attribute. |
 | `align`                                 | `string`             | _(optional)_ Lateral alignment of contents of input field, one of `left` (default), `center`, or `right`.                                                       |
-| `help`                                  | `object`             | _(optional)_ Provide a help button. Object consisting of `title` and `contents`.                                                                                |
+| `help`                                  | `object`             | _(optional)_ Provide a help button. Object consisting of `title` and `content`.                                                                                 |
 | `autoComplete`                          | `on` or `string`     | _(optional)_ For HTML `autocomplete` [attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete).                                   |
 | `step`                                  | `number`             | _(optional)_ Determines step granularity when in/decreasing value input through step controls buttons or arrow keys.                                            |
 | `showStepControls`                      | `boolean`            | _(optional)_ Show buttons that in/decreases value input by the step value.                                                                                      |

diff --git a/...b-design-system-portal/src/docs/uilib/extensions/forms/base-fields/Selection/Examples.tsx b/...b-design-system-portal/src/docs/uilib/extensions/forms/base-fields/Selection/Examples.tsx
@@ -110,7 +110,7 @@ export const WithHelp = () => {
         label="Label text"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Somewhere along the way, we must learn that there is nothing greater than to do something for others.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...tem-portal/src/docs/uilib/extensions/forms/base-fields/Selection/properties.mdx b/...tem-portal/src/docs/uilib/extensions/forms/base-fields/Selection/properties.mdx
@@ -13,7 +13,7 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 | `variant`                               | `string`            | _(optional)_ Choice of UI feature. Can be: `dropdown`, `radio` or `button`.                                   |
 | `optionsLayout`                         | `string`            | _(optional)_ Layout for the list of options. Can be `horizontal` or `vertical`.                               |
 | `width`                                 | `string` or `false` | _(optional)_ `small`, `medium` or `large` for predefined standard widths, `stretch` for fill available width. |
-| `help`                                  | `object`            | _(optional)_ Provide a help button. Object consisting of `title` and `contents`.                              |
+| `help`                                  | `object`            | _(optional)_ Provide a help button. Object consisting of `title` and `content`.                               |
 | `clear`                                 | `boolean`           | _(optional)_ True to have a clear-option to remove selected option as value.                                  |
 | `children`                              | `React.Node`        | _(optional)_ For providing Option components.                                                                 |
 | [Space](/uilib/layout/space/properties) | Various             | _(optional)_ Spacing properties like `top` or `bottom` are supported.                                         |

diff --git a/.../dnb-design-system-portal/src/docs/uilib/extensions/forms/base-fields/String/Examples.tsx b/.../dnb-design-system-portal/src/docs/uilib/extensions/forms/base-fields/String/Examples.tsx
@@ -56,7 +56,7 @@ export const WithHelp = () => {
         value="foo"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Take the time to help other people without expecting a reward or gratitude is definitely important in living an optimistic life.',
         }}
         onChange={(value) => console.log('onChange', value)}
@@ -393,7 +393,7 @@ export const MultipleWithHelp = () => {
         label="Label text"
         help={{
           title: 'Help is available',
-          contents: 'There is more happiness in giving than in receiving.',
+          content: 'There is more happiness in giving than in receiving.',
         }}
         multiline
         onChange={(value) => console.log('onChange', value)}

diff --git a/...system-portal/src/docs/uilib/extensions/forms/base-fields/String/properties.mdx b/...system-portal/src/docs/uilib/extensions/forms/base-fields/String/properties.mdx
@@ -26,7 +26,7 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 | `maxLength`                             | `number`            | _(optional)_ Validation for maximum length of the text (number of characters).                                                                                      |
 | `pattern`                               | `string`            | _(optional)_ Validation based on regex pattern.                                                                                                                     |
 | `width`                                 | `string` or `false` | _(optional)_ `false` for no width (use browser default), `small`, `medium` or `large` for predefined standard widths, `stretch` for fill available width.           |
-| `help`                                  | `object`            | _(optional)_ Provide a help button. Object consisting of `title` and `contents`.                                                                                    |
+| `help`                                  | `object`            | _(optional)_ Provide a help button. Object consisting of `title` and `content`.                                                                                     |
 | [Space](/uilib/layout/space/properties) | Various             | _(optional)_ Spacing properties like `top` or `bottom` are supported.                                                                                               |
 
 ## Properties

diff --git a/...gn-system-portal/src/docs/uilib/extensions/forms/create-component/FieldBlock/Examples.tsx b/...gn-system-portal/src/docs/uilib/extensions/forms/create-component/FieldBlock/Examples.tsx
@@ -87,25 +87,25 @@ export const Widths = () => {
 
         <FieldBlock
           label="Small (affects contents only)"
-          contentsWidth="small"
+          contentWidth="small"
         >
           <TestElement>Contents</TestElement>
         </FieldBlock>
         <FieldBlock
           label="Medium (affects contents only)"
-          contentsWidth="medium"
+          contentWidth="medium"
         >
           <TestElement>Contents</TestElement>
         </FieldBlock>
         <FieldBlock
           label="Large (affects contents only)"
-          contentsWidth="large"
+          contentWidth="large"
         >
           <TestElement>Contents</TestElement>
         </FieldBlock>
         <FieldBlock
           label="Stretch (affects contents only)"
-          contentsWidth="stretch"
+          contentWidth="stretch"
         >
           <TestElement>Contents</TestElement>
         </FieldBlock>

diff --git a/...rtal/src/docs/uilib/extensions/forms/create-component/FieldBlock/properties.mdx b/...rtal/src/docs/uilib/extensions/forms/create-component/FieldBlock/properties.mdx
@@ -7,7 +7,7 @@ showTabs: true
 | Property                                                                                                          | Type                | Description                                                                                                 |
 | ----------------------------------------------------------------------------------------------------------------- | ------------------- | ----------------------------------------------------------------------------------------------------------- |
 | `width`                                                                                                           | `string` or `false` | _(optional)_ `small`, `medium`, `large`, `stretch` or `false` for predefined standard widths.               |
-| `contentsWidth`                                                                                                   | `string` or `false` | _(optional)_ `small`, `medium`, `large`, `stretch` or `false` for predefined standard widths.               |
+| `contentWidth`                                                                                                    | `string` or `false` | _(optional)_ `small`, `medium`, `large`, `stretch` or `false` for predefined standard widths.               |
 | `size`                                                                                                            | `string` or `false` | _(optional)_ define one of the following [heading size](/uilib/elements/heading/): `medium` or `large`.     |
 | `asFieldset`                                                                                                      | `boolean`           | _(optional)_ use `true` when you have several form elements. This way a `fieldset` with a `legend` is used. |
 | `disabled`                                                                                                        | `boolean`           | _(optional)_ set `true` to make the inner [FormLabel](/uilib/components/form-label/) behave as disabled.    |

diff --git a/...stem-portal/src/docs/uilib/extensions/forms/feature-fields/BankAccountNumber/Examples.tsx b/...stem-portal/src/docs/uilib/extensions/forms/feature-fields/BankAccountNumber/Examples.tsx
@@ -64,7 +64,7 @@ export const WithHelp = () => {
         value="20001234567"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'The real point is that we all need help somewhere along life’s path whether we think we will or not. And, if you are the one giving and helping, just remember this: no matter what happens later, you will always be secure in the fact knowing that you have remained strong and true to assist those that need your help.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...src/docs/uilib/extensions/forms/feature-fields/BankAccountNumber/properties.mdx b/...src/docs/uilib/extensions/forms/feature-fields/BankAccountNumber/properties.mdx
@@ -8,10 +8,10 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 
 ### Component-specific props
 
-| Property                                | Type      | Description                                                                      |
-| --------------------------------------- | --------- | -------------------------------------------------------------------------------- |
-| `validate`                              | `boolean` | _(optional)_ Using this prop you can disable the default validation.             |
-| `help`                                  | `object`  | _(optional)_ Provide a help button. Object consisting of `title` and `contents`. |
-| [Space](/uilib/layout/space/properties) | Various   | _(optional)_ Spacing properties like `top` or `bottom` are supported.            |
+| Property                                | Type      | Description                                                                     |
+| --------------------------------------- | --------- | ------------------------------------------------------------------------------- |
+| `validate`                              | `boolean` | _(optional)_ Using this prop you can disable the default validation.            |
+| `help`                                  | `object`  | _(optional)_ Provide a help button. Object consisting of `title` and `content`. |
+| [Space](/uilib/layout/space/properties) | Various   | _(optional)_ Spacing properties like `top` or `bottom` are supported.           |
 
 <DataValueReadwriteProperties type="string" />
diff --git a/...design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Currency/Examples.tsx b/...design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Currency/Examples.tsx
@@ -56,7 +56,7 @@ export const WithHelp = () => {
         label="Amount"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Helping others, without expecting anything in return is what true self-worth is all about.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...m-portal/src/docs/uilib/extensions/forms/feature-fields/Currency/properties.mdx b/...m-portal/src/docs/uilib/extensions/forms/feature-fields/Currency/properties.mdx
@@ -8,10 +8,10 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 
 ### Component-specific props
 
-| Property                                | Type     | Description                                                                      |
-| --------------------------------------- | -------- | -------------------------------------------------------------------------------- |
-| `currency`                              | `string` | _(optional)_ Currency to show the value in. I.e `NOK` or `USD`.                  |
-| `help`                                  | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents`. |
-| [Space](/uilib/layout/space/properties) | Various  | _(optional)_ Spacing properties like `top` or `bottom` are supported.            |
+| Property                                | Type     | Description                                                                     |
+| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
+| `currency`                              | `string` | _(optional)_ Currency to show the value in. I.e `NOK` or `USD`.                 |
+| `help`                                  | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `content`. |
+| [Space](/uilib/layout/space/properties) | Various  | _(optional)_ Spacing properties like `top` or `bottom` are supported.           |
 
 <DataValueReadwriteProperties type="number" />
diff --git a/...dnb-design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Date/Examples.tsx b/...dnb-design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Date/Examples.tsx
@@ -51,7 +51,7 @@ export const WithHelp = () => {
         label="Label text"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Kindness and helping others will return to you when you least expect it, and maybe when you need it.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...ystem-portal/src/docs/uilib/extensions/forms/feature-fields/Date/properties.mdx b/...ystem-portal/src/docs/uilib/extensions/forms/feature-fields/Date/properties.mdx
@@ -8,9 +8,9 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 
 ### Component-specific props
 
-| Property                                | Type     | Description                                                                      |
-| --------------------------------------- | -------- | -------------------------------------------------------------------------------- |
-| `help`                                  | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents`. |
-| [Space](/uilib/layout/space/properties) | Various  | _(optional)_ Spacing properties like `top` or `bottom` are supported.            |
+| Property                                | Type     | Description                                                                     |
+| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
+| `help`                                  | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `content`. |
+| [Space](/uilib/layout/space/properties) | Various  | _(optional)_ Spacing properties like `top` or `bottom` are supported.           |
 
 <DataValueReadwriteProperties type="string" />
diff --git a/...nb-design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Email/Examples.tsx b/...nb-design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Email/Examples.tsx
@@ -51,7 +51,7 @@ export const WithHelp = () => {
         value="[email protected]"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Use your gifts to teach and help others. Acknowledge them as gifts (even if only in your mind). Take some time to list your strengths as well as the ways in which you could share them with the world around you and how that truly is a gift to others.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...stem-portal/src/docs/uilib/extensions/forms/feature-fields/Email/properties.mdx b/...stem-portal/src/docs/uilib/extensions/forms/feature-fields/Email/properties.mdx
@@ -8,9 +8,9 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 
 ### Component-specific props
 
-| Property                                | Type     | Description                                                                      |
-| --------------------------------------- | -------- | -------------------------------------------------------------------------------- |
-| `help`                                  | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `contents`. |
-| [Space](/uilib/layout/space/properties) | Various  | _(optional)_ Spacing properties like `top` or `bottom` are supported.            |
+| Property                                | Type     | Description                                                                     |
+| --------------------------------------- | -------- | ------------------------------------------------------------------------------- |
+| `help`                                  | `object` | _(optional)_ Provide a help button. Object consisting of `title` and `content`. |
+| [Space](/uilib/layout/space/properties) | Various  | _(optional)_ Spacing properties like `top` or `bottom` are supported.           |
 
 <DataValueReadwriteProperties type="string" />
diff --git a/...b-design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Expiry/Examples.tsx b/...b-design-system-portal/src/docs/uilib/extensions/forms/feature-fields/Expiry/Examples.tsx
@@ -30,7 +30,7 @@ export const WithHelp = () => {
         label="Label text"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Kindness and helping others will return to you when you least expect it, and maybe when you need it.',
         }}
         onChange={(expiry) => console.log('onChange', expiry)}

diff --git a/...portal/src/docs/uilib/extensions/forms/feature-fields/NationalIdentityNumber/Examples.tsx b/...portal/src/docs/uilib/extensions/forms/feature-fields/NationalIdentityNumber/Examples.tsx
@@ -64,7 +64,7 @@ export const WithHelp = () => {
         value="01017501234"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'The more I help others to succeed, the more I succeed.',
         }}
         onChange={(value) => console.log('onChange', value)}

diff --git a/...ocs/uilib/extensions/forms/feature-fields/NationalIdentityNumber/properties.mdx b/...ocs/uilib/extensions/forms/feature-fields/NationalIdentityNumber/properties.mdx
@@ -8,10 +8,10 @@ import DataValueReadwriteProperties from '../../data-value-readwrite-properties.
 
 ### Component-specific props
 
-| Property                                | Type      | Description                                                                      |
-| --------------------------------------- | --------- | -------------------------------------------------------------------------------- |
-| `validate`                              | `boolean` | _(optional)_ Using this prop you can disable the default validation.             |
-| `help`                                  | `object`  | _(optional)_ Provide a help button. Object consisting of `title` and `contents`. |
-| [Space](/uilib/layout/space/properties) | Various   | _(optional)_ Spacing properties like `top` or `bottom` are supported.            |
+| Property                                | Type      | Description                                                                     |
+| --------------------------------------- | --------- | ------------------------------------------------------------------------------- |
+| `validate`                              | `boolean` | _(optional)_ Using this prop you can disable the default validation.            |
+| `help`                                  | `object`  | _(optional)_ Provide a help button. Object consisting of `title` and `content`. |
+| [Space](/uilib/layout/space/properties) | Various   | _(optional)_ Spacing properties like `top` or `bottom` are supported.           |
 
 <DataValueReadwriteProperties type="string" />
diff --git a/...tem-portal/src/docs/uilib/extensions/forms/feature-fields/OrganizationNumber/Examples.tsx b/...tem-portal/src/docs/uilib/extensions/forms/feature-fields/OrganizationNumber/Examples.tsx
@@ -64,7 +64,7 @@ export const WithHelp = () => {
         value="987654321"
         help={{
           title: 'Help is available',
-          contents:
+          content:
             'Success has nothing to do with what you gain in life or accomplish for yourself. It’s what you do for others.',
         }}
         onChange={(value) => console.log('onChange', value)}