@iress-oss/ids-mcp-server 5.15.0 → 6.0.0-alpha.0

package/generated/docs/components-label-docs.md

@@ -6,6 +6,14 @@ Overview
 
 Use the `IressLabel` component when building bespoke form inputs and `IressField` is too restrictive.
 
+* * *
+
+Updated
+
+**Recently updated**
+
+This component has been recently updated with new props. The props have been marked as beta. Please tell us if there are any issues.
+
 **This is a label**
 
 Hide code
@@ -18,53 +26,473 @@ Hide code
 
 Copy
 
-[](#examples)Examples
----------------------
+[](#props)Props
+---------------
 
-### [](#required)Required
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| append | 
+Content to be appended to the label. This is not affected by the `hiddenLabel` prop.
 
-To indicate that an input is required, you may use the `required` prop to distinguish the label with an asterix.
+string | number | boolean | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | null | undefined
 
-**\*Required This is a label for a required input**
+ | \- | Set object |
+| bg | 
 
-Hide code
+**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
 
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+We recommend using the following token values for best background contrast:
 
-<IressLabel required\>
-  This is a label for a required input
-</IressLabel\>
+*   `colour.primary.fill` for primary backgrounds that need to stand out
+*   `colour.primary.surface` for primary backgrounds that need to be less prominent
+*   `colour.neutral.10` for the base background color, normally white in light mode or shade of grey in dark mode
+*   `colour.neutral.20` for a slightly darker background color, used in neutral state components
+*   `colour.system.danger.fill` for error backgrounds that need to stand out
+*   `colour.system.danger.surface` for error backgrounds that need to be less prominent
+*   `colour.system.success.fill` for success backgrounds that need to stand out
+*   `colour.system.success.surface` for success backgrounds that need to be less prominent
+*   `colour.system.warning.fill` for warning backgrounds that need to stand out
+*   `colour.system.warning.surface` for warning backgrounds that need to be less prominent
+*   `colour.system.info.fill` for info backgrounds that need to stand out
+*   `colour.system.info.surface` for info backgrounds that need to be less prominent
 
-Copy
+"colorPalette""colour.primary.fill""colour.primary.fillHover""colour.primary.onFill""colour.primary.surface""colour.primary.surfaceHover""colour.primary.text"... 33 more ...Show 1 more...
 
-### [](#optional)Optional
 
-Alternatively, if the majority of your form inputs are required, you may wish to distinguish only the optional inputs. For this, use the `optional` prop.
 
-The `optional` prop also accepts a string, in which case it will replace the default "(optional)" label, useful when you need to support translation.
+ | \- | Set object |
+| borderRadius | 
 
-**Note:** that the `optional` and `required` props are mutually exclusive, with `required` taking precedence.
+The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
 
-**This is a label for an optional input(optional)**
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **4** | **4** | **5** | **12** | **9** |
+| 1 _\-x-_ |  | 3 _\-x-_ |  |  |
 
-Hide code
+"none" | "radius.000" | "radius.025" | "radius.050" | "radius.075" | "radius.100" | "radius.system.badge" | "radius.system.button" | "radius.system.form" | "radius.system.layout" | Partial<...> | undefined
 
-\[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
+ | \- | Set object |
+| children | 
 
-<IressLabel optional\>
-  This is a label for an optional input
-</IressLabel\>
+string
 
-Copy
 
-**This is a label for an optional input(选修的)**
+
+ | \- | This is a label |
+| color | 
+
+The **`color`** CSS property sets the foreground color value of an element's text and text decorations using the colour tokens from the design system. It also sets the `currentcolor` value. `currentcolor` may be used as an indirect value on _other_ properties and is the default for other color properties, such as `border-color`.
+
+We recommend using the following token values for best color contrast:
+
+*   `colour.primary.onFill` used on top of `colour.primary.fill` for primary text that needs to stand out
+*   `colour.primary.text` used on top of `colour.primary.surface` or `colour.neutral.10` for primary text that needs to be less prominent
+*   `colour.neutral.70` used on top of `colour.neutral.10` or `colour.neutral.20` for muted text
+*   `colour.neutral.80` used on top of `colour.neutral.10` or `colour.neutral.20` for standard text
+*   `colour.system.danger.onFill` used on top of `colour.system.danger.fill` for error text that needs to stand out
+*   `colour.system.danger.text` used on top of `colour.system.danger.surface` for error text that needs to be less prominent
+*   `colour.system.success.onFill` used on top of `colour.system.success.fill` for success text that needs to stand out
+*   `colour.system.success.text` used on top of `colour.system.success.surface` for success text that needs to be less prominent
+*   `colour.system.warning.onFill` used on top of `colour.system.warning.fill` for warning text that needs to stand out
+*   `colour.system.warning.text` used on top of `colour.system.warning.surface` for warning text that needs to be less prominent
+*   `colour.system.info.onFill` used on top of `colour.system.info.fill` for informative text that needs to stand out
+*   `colour.system.info.text` used on top of `colour.system.info.surface` for informative text that needs to be less prominent
+
+"colorPalette""colour.primary.fill""colour.primary.fillHover""colour.primary.onFill""colour.primary.surface""colour.primary.surfaceHover""colour.primary.text"... 33 more ...Show 1 more...
+
+
+
+ | \- | Set object |
+| focusable | 
+
+The `focusable` prop is used to apply the focus elevation when focused. It can be set to `true` to apply focus styles on focus, or `'within'` to apply focus styles when the element or any of its children are focused.
+
+"true""within"undefined
+
+
+
+ | \- | Set object |
+| hiddenLabel | 
+
+Visually hides the label text, but still available to screen readers.
+
+booleanundefined
+
+
+
+ | \- | Set object |
+| hide | 
+
+Set **`hide`** to hide an element completely using `display: none`. It can also be set to an object of breakpoints to hide the element at specific breakpoints.
+
+Hide on all breakpoints: `hide: true` Hide on specific breakpoints: `hide: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
+
+Notes:
+
+*   If you need to hide an element but allow it to be visible to screen readers, use the `srOnly` prop instead.
+*   Consider if you can conditionally render the element instead of hiding it.
+
+boolean | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", boolean>> | undefined
+
+ | \- | Set object |
+| htmlFor | 
+
+Used to connect it to the input element, it should be the input's id. If provided, the label will be rendered as a `<label>` element, otherwise it will be rendered as a `<strong>` element.
+
+[Learn more](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/for)
+
+stringundefined
+
+
+
+ | \- | Set object |
+| layerStyle | 
+
+Elevate a layer by using a **`layerStyle`**. These are connected to the elevation tokens in the design system. They can be combined to create hierarchy and structure.
+
+*   `elevation.raised`: Raised elevations sit slightly higher than other content. They are reserved for cards that can be moved, such as Jira issue cards and Trello cards. In special circumstances, they can be used for cards as a way to provide additional heirarchy or emphasis.
+*   `elevation.floating`: Floating is the highest elevation available. It is reserved for a UI that sits over another UI, such as modals, dialogs, dropdown menus, floating toolbars, and floating single-action buttons.
+*   `elevation.overflow`: Overflow is a shadow indicating content has scrolled outside a view. It can be used for vertical or horizontal scroll. An example of overflow shadows is the horizontal scroll in tables on a Confluence page.
+
+"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "elevation.focusCompact" | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", "elevation.raised" | ... 3 more ... | "elevation.focusCompact">> | undefined
+
+ | \- | Set object |
+| m | 
+
+The **`m`** property is short for `margin`, and sets the margin area on all four sides of an element.
+
+It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| maxWidth | 
+
+The **`max-width`** CSS property sets the maximum width of an element. It prevents the used value of the `width` property from becoming larger than the value specified by `max-width`.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **7** |
+
+"slider.tick""auto""container.xs""container.sm""container.md""container.lg""container.xl""container.xxl"Show 6 more...
+
+
+
+ | \- | Set object |
+| mb | 
+
+The **`mb`** property is short for `margin-bottom` and sets the margin area on the bottom side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
+
+It uses the spacing tokens in the design system.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| ml | 
+
+The **`ml`** property is short for `margin-left` and sets the margin area on the left side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
+
+It uses the spacing tokens in the design system.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| mr | 
+
+The **`mr`** property is short for `margin-right` and sets the margin area on the right side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
+
+It uses the spacing tokens in the design system.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| mt | 
+
+The **`mt`** property is short for `margin-top` and sets the margin area on the top side of an element. A positive value places it farther from its neighbors, while a negative value places it closer.
+
+It uses the spacing tokens in the design system.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| mx | 
+
+The **`mx`** property is short for `margin-inline`. It is a shorthand property that defines both the logical inline start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
+
+It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| my | 
+
+The **`my`** property is short for `margin-block`. It defines the logical block start and end margins of an element, which maps to physical margins depending on the element's writing mode, directionality, and text orientation.
+
+It uses the spacing tokens in the design system. You can also use the negative values to overlap elements or ignore padding based on the design requirements.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| noGutter | 
+
+The **`noGutter`** property is used to remove the bottom margin from the last child of a component. This is useful when you want to avoid extra spacing at the end of a layout.
+
+booleanundefined
+
+
+
+ | \- | Set object |
+| p | 
+
+The **`p`** property is short for `padding`, and sets the padding area on all four sides of an element at once.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| pb | 
+
+The **`pb`** property is short for `padding-bottom` and sets the padding area on the bottom side of an element.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| pl | 
+
+The **`pl`** property is short for `padding-left` and sets the padding area on the left side of an element.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| pr | 
+
+The **`pr`** property is short for `padding-right` and sets the padding area on the right side of an element.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| pt | 
+
+The **`pt`** property is short for `padding-top` and sets the padding area on the top side of an element.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| px | 
+
+The **`px`** property is short for `padding-inline`. It is a shorthand property that defines both the logical inline start and end paddings of an element, which maps to physical paddings depending on the element's writing mode, directionality, and text orientation.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| py | 
+
+The **`py`** property is short for `padding-block`. It defines the logical block start and end paddings of an element, which maps to physical paddings depending on the element's writing mode, directionality, and text orientation.
+
+It uses the spacing tokens in the design system. Padding cannot use negative values, if you need to overlap elements or ignore padding, use the margin property instead.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| required | 
+
+When set to true, the 'required asterisk (\*)' is displayed next to the label text.
+
+booleanundefined
+
+
+
+ | \- | Set object |
+| rowGap | 
+
+The **`row-gap`** CSS property sets the size of the gap (gutter) between an element's rows.
+
+Note: It only has an effect when used as a direct child of a layout component, such as IressRow, IressStack or IressInline.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **47** | **52** | **10.1** | **16** | No |
+
+"xs""sm""md""lg""xl""none""spacing.000""spacing.050"Show 9 more...
+
+
+
+ | \- | Set object |
+| srOnly | 
+
+Set **`srOnly`** to hide an element visually but still make it accessible to screen readers. It can also be set to an object of breakpoints to hide the element at specific breakpoints.
+
+Hide on all breakpoints: `srOnly: true` Hide on specific breakpoints: `srOnly: { xs: false, sm: true, md: false, lg: true, xl: false, xxl: true }`
+
+boolean | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", boolean>> | undefined
+
+ | \- | Set object |
+| stretch | 
+
+The **`stretch`** property is used to stretch an element to fill the available space in its parent container. It sets the `height` property to `100%` and `alignSelf` to `stretch`, allowing the element to expand and contract based on the size of its parent.
+
+booleanundefined
+
+
+
+ | \- | Set object |
+| textAlign | 
+
+The **`text-align`** CSS property sets the horizontal alignment of the inline-level content inside a block element or table-cell box.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **3** |
+
+"center" | "left" | "right" | "inherit" | "justify" | Partial<Record<"base" | "xs" | "sm" | "md" | "lg" | "xl" | "xxl", "center" | "left" | "right" | "inherit" | "justify">> | undefined
+
+ | \- | Set object |
+| textStyle | 
+
+Select the typography to be used using the **`textStyle`** prop. These are connected to the typography tokens in the design system.'
+
+*   `typography.body.sm` - Use for small components such as badges and disclaimers, as well as compact variations of tables and lists.
+*   `typography.body.md` - The most commonly used body text size, used for most text content in the product and the default state of all components in the design system.
+*   `typography.body.lg` - Use for tag lines, subtitles, and other large text content in the product.
+*   `typography.heading.1` - Use for the main page title to establish a clear hierarchy. There is typically only one H1 per screen, emphasising the primary purpose or context of the page.
+*   `typography.heading.2` - Use for primary section headings within a page to organise content and guide the user through key areas. Also suitable for large components—such as modals—where space allows and where it pairs well with body.md or body.lg.
+*   `typography.heading.3` - Use for sub-sections under H2s to further structure content and maintain a clear visual hierarchy. Ideal for breaking down complex sections into manageable parts.
+*   `typography.heading.4` - Use for supporting headings within content blocks or small components where space is limited—such as table headers, cards, or side panels. Provides structure without overwhelming the layout.
+*   `typography.heading.5` - Use for minor labels or titles in compact UI elements, such as cards, sidebars, or inline labels. Best used to emphasise supplementary information without drawing too much attention. Works well with body.sm and is ideal for subtle content like fine print. Use sparingly to preserve typographic hierarchy.
+*   `typography.code` - Used to display code snippets in the product, such as in the API documentation.
+
+"typography.heading.1""typography.heading.2""typography.heading.3""typography.heading.4""typography.heading.5""typography.body.sm""typography.body.sm.regular"... 12 more ...Show 1 more...
+
+
+
+ | \- | Set object |
+| width | 
+
+The **`width`** CSS property sets an element's width. By default, it sets the width of the content area, but if `box-sizing` is set to `border-box`, it sets the width of the border area.
+
+This prop only allows widths available throughout the component library. To use a custom width, you need to use the `style` prop, or add a custom class to the element and use CSS.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **1** | **1** | **1** | **12** | **4** |
+
+"slider.tick""auto""container.xs""container.sm""container.md""container.lg""container.xl""container.xxl"Show 6 more...
+
+
+
+ | \- | Set object |
+
+[](#examples)Examples
+---------------------
+
+### [](#required)Required
+
+To indicate that an input is required, you may use the `required` prop to distinguish the label with an asterix.
+
+**\*RequiredThis is a label for a required input**
 
 Hide code
 
 \[data-radix-scroll-area-viewport\] { scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; } \[data-radix-scroll-area-viewport\]::-webkit-scrollbar { display: none; } :where(\[data-radix-scroll-area-viewport\]) { display: flex; flex-direction: column; align-items: stretch; } :where(\[data-radix-scroll-area-content\]) { flex-grow: 1; }
 
-<IressLabel optional\="(选修的)"\>
-  This is a label for an optional input
+<IressLabel required\>
+  This is a label for a required input
 </IressLabel\>
 
 Copy
@@ -101,7 +529,7 @@ Hide code
 
 <IressLabel\>
   <IressInline
-    gutter\="md"
+    gap\="md"
     verticalAlign\="middle"
   \>
     <IressIcon name\="home" />
@@ -128,7 +556,6 @@ On this page
 *   [Props](#props)
 *   [Examples](#examples)
     *   [Required](#required)
-    *   [Optional](#optional)
     *   [Hidden label](#hidden-label)
     *   [Rich content](#rich-content)
 *   [Accessibility](#accessibility)