@iress-oss/ids-mcp-server 6.0.0-alpha.1-canary-20251204032753-fe18cab → 6.0.0-alpha.1-canary-20251204040305-3639454

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

@@ -0,0 +1,229 @@
+Label
+=====
+
+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.
+
+[](./iframe.html?id=components-label--default)
+
+**This is a label**
+
+```
+
+<IressLabel\>
+  This is a label
+</IressLabel\>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children\* | 
+Content to be displayed in the label. This can also include error messages to make sure it makes sense in this context.
+
+ReactNode
+
+
+
+ | \- | 
+
+"This is a label"
+
+ |
+| 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)
+
+THtmlFor
+
+
+
+ | \- | Set object |
+
+Examples
+--------
+
+### Required
+
+To indicate that an input is required, you may use the `required` prop to distinguish the label with an asterix.
+
+[](./iframe.html?id=components-label--required)
+
+**\*RequiredThis is a label for a required input**
+
+```
+
+<IressLabel required\>
+  This is a label for a required input
+</IressLabel\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children\* | 
+Content to be displayed in the label. This can also include error messages to make sure it makes sense in this context.
+
+ReactNode
+
+
+
+ | \- | 
+
+"This is a label for a required input"
+
+ |
+| 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)
+
+THtmlFor
+
+
+
+ | \- | Set object |
+| required | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+
+### Hidden label
+
+Sometimes you may wish to have an input with no visible label, but to still wrap the input in a label for accessibility. In this case, set `hiddenLabel` to `true`.
+
+[](./iframe.html?id=components-label--hidden-label)
+
+**This text is visible to screen readers only**
+
+```
+
+<IressLabel hiddenLabel\>
+  This text is visible to screen readers only
+</IressLabel\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children\* | 
+Content to be displayed in the label. This can also include error messages to make sure it makes sense in this context.
+
+ReactNode
+
+
+
+ | \- | 
+
+"This text is visible to screen readers only"
+
+ |
+| hiddenLabel | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| 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)
+
+THtmlFor
+
+
+
+ | \- | Set object |
+
+### Rich content
+
+You can render custom content into the label.
+
+[](./iframe.html?id=components-label--rich-content)
+
+**
+
+Home settings
+
+**
+
+```
+
+<IressLabel\>
+  <IressInline
+    gap\="md"
+    verticalAlign\="middle"
+  \>
+    <IressIcon name\="home" />
+    Home settings    <IressIcon name\="cog" />
+  </IressInline\>
+</IressLabel\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children\* | 
+Content to be displayed in the label. This can also include error messages to make sure it makes sense in this context.
+
+ReactNode
+
+
+
+ | \- | \- |
+| hiddenLabel | 
+
+boolean
+
+
+
+ | \- | FalseTrue |
+| 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)
+
+THtmlFor
+
+
+
+ | \- | Set object |
+
+Accessibility
+-------------
+
+Don't place interactive elements such as anchors or buttons inside the `IressLabel`. Doing so makes it difficult for people to activate the form input associated with the label.
+
+See the [MDN Label Docs](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/label#accessibility_concerns) for more info.
+
+### Labelling non-interactive content
+
+`IressLabel` can be used to label non-interactive content, such as readonly data. In this case, do not provide a `htmlFor` prop. This will render the label using a `strong` tag instead of a `label` tag.

package/generated/docs/components_components-link-docs.md

@@ -0,0 +1,454 @@
+Link
+====
+
+Overview
+--------
+
+A link is used to navigate to another page or location.
+
+* * *
+
+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.
+
+[](./iframe.html?id=components-link--default)
+
+Hello, I am a paragraph with an [IressLink](//iress.com) inside.
+
+```
+
+<IressPanel\>
+  Hello, I am a paragraph with an{' '}
+  <IressLink href\="//iress.com"\>
+    IressLink  </IressLink\>
+  {' '}inside.
+</IressPanel\>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| active | 
+Sets the active state of the link, usually used to indicate the link has activated a modal, popover or slideout.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content for the append slot.
+
+ReactNode
+
+
+
+ | \- | Set object |
+| children | 
+
+Content is placed between prepend and append if provided. Used to describe the expected intention of this link.
+
+ReactNode
+
+
+
+ | \- | 
+
+"IressLink"
+
+ |
+| element | 
+
+Change the component that will be rendered as the link, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
+
+C
+
+
+
+ | \- | Set object |
+| href | 
+
+Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
+
+THref
+
+
+
+ | \- | 
+
+"//iress.com"
+
+ |
+| loading | 
+
+When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
+
+union
+
+
+
+ | 
+
+false
+
+ | Set object |
+| onClick | 
+
+Emitted when the menu item is clicked.
+
+MouseEventHandler
+
+
+
+ | \- | Set object |
+| prepend | 
+
+Content for the prepend slot.
+
+ReactNode
+
+
+
+ | \- | Set object |
+
+Usage
+-----
+
+`IressLink` is an alternative to the `IressButton` component, and is used when you want to add interactive text inside a block of static text.
+
+If you provide a `href`, it will render as an `<a />` element. Otherwise it will render as a `<button />` element. This helps ensure it presents the correct role to assistive technologies for the best accessibility.
+
+When to use
+-----------
+
+*   If you want to include a link alongside static text, use the `IressLink` component.
+*   If you want to have a call to action at the start or end of a block of contents, use the `IressButton` component instead.
+
+Examples
+--------
+
+### Loading
+
+Loading buttons give the user an indication something is happening (eg. a form submission or extra content being loaded) after they have been triggered.
+
+The loading state can be activated by setting the `loading` prop to `true` and providing some `loadingText` for screenreaders to announce when in loading state (which defaults to Loading...).
+
+When the loading state is activated, any click events on the link are disabled.
+
+[](./iframe.html?id=components-link--loading)
+
+Link text
+
+```
+
+<IressLink loading\>
+  Link text
+</IressLink\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| active | 
+Sets the active state of the link, usually used to indicate the link has activated a modal, popover or slideout.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content for the append slot.
+
+ReactNode
+
+
+
+ | \- | Set object |
+| children | 
+
+Content is placed between prepend and append if provided. Used to describe the expected intention of this link.
+
+ReactNode
+
+
+
+ | \- | 
+
+"Link text"
+
+ |
+| element | 
+
+Change the component that will be rendered as the link, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
+
+C
+
+
+
+ | \- | Set object |
+| href | 
+
+Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
+
+THref
+
+
+
+ | \- | Set object |
+| loading | 
+
+When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
+
+union
+
+
+
+ | 
+
+false
+
+ | 
+
+true
+
+ |
+| onClick | 
+
+Emitted when the menu item is clicked.
+
+MouseEventHandler
+
+
+
+ | \- | Set object |
+| prepend | 
+
+Content for the prepend slot.
+
+ReactNode
+
+
+
+ | \- | Set object |
+
+### Slot props
+
+Use the slots to correctly position icons or badges inside buttons.
+
+*   **Prepend** - Places the element before the text
+*   **Append** - Places the element after the text
+
+[](./iframe.html?id=components-link--slots)
+
+Prepend iconAppend icon
+
+```
+
+<IressInline gap\="md"\>
+  <IressLink prepend\={<IressIcon name\="home" />}\>
+    Prepend icon  </IressLink\>
+  <IressLink append\={<IressIcon name\="home" />}\>
+    Append icon  </IressLink\>
+</IressInline\>
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| active | 
+Sets the active state of the link, usually used to indicate the link has activated a modal, popover or slideout.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| append | 
+
+Content for the append slot.
+
+ReactNode
+
+
+
+ | \- | \- |
+| children | 
+
+Content is placed between prepend and append if provided. Used to describe the expected intention of this link.
+
+ReactNode
+
+
+
+ | \- | \- |
+| element | 
+
+Change the component that will be rendered as the link, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
+
+C
+
+
+
+ | \- | Set object |
+| href | 
+
+Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
+
+THref
+
+
+
+ | \- | Set object |
+| loading | 
+
+When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
+
+union
+
+
+
+ | 
+
+false
+
+ | Set object |
+| onClick | 
+
+Emitted when the menu item is clicked.
+
+MouseEventHandler
+
+
+
+ | \- | Set object |
+| prepend | 
+
+Content for the prepend slot.
+
+ReactNode
+
+
+
+ | \- | \- |
+
+### Element
+
+You can use the `element` prop to render a custom component as the link. This is useful for rendering a component from a third-party library, such as `react-router-dom`.
+
+[](./iframe.html?id=components-link--element)
+
+[Iress](https://iress.com)
+
+```
+
+/\*\*
+ \* This could be the \`Link\` component from \`react-router-dom\` or any other routing library. \*/
+const Link \= forwardRef<
+  HTMLAnchorElement,
+  HTMLAttributes<HTMLAnchorElement\> & { to: string }
+\>(({ children, className, to, ...restProps }, ref) \=> (
+  <div className\={className}\>
+    <a href\={to} ref\={ref} {...restProps}\>
+      {children}
+    </a\>
+  </div\>
+));
+export const RoutingLink \= () \=> (
+  <IressLink element\={Link} to\="https://iress.com"\>
+    Iress  </IressLink\>
+);
+
+```
+
+#### Props
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| active | 
+Sets the active state of the link, usually used to indicate the link has activated a modal, popover or slideout.
+
+boolean
+
+
+
+ | \- | \- |
+| append | 
+
+Content for the append slot.
+
+ReactNode
+
+
+
+ | \- | \- |
+| children | 
+
+Content is placed between prepend and append if provided. Used to describe the expected intention of this link.
+
+ReactNode
+
+
+
+ | \- | \- |
+| element | 
+
+Change the component that will be rendered as the link, used for third-party libraries that require a specific element type. By default, it will render a button or an anchor tag based on the `href` prop.
+
+C
+
+
+
+ | \- | \- |
+| href | 
+
+Contains a URL or a URL fragment that the hyperlink points to. If this property is set, an anchor tag will be rendered.
+
+THref
+
+
+
+ | \- | \- |
+| loading | 
+
+When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
+
+union
+
+
+
+ | 
+
+false
+
+ | \- |
+| onClick | 
+
+Emitted when the menu item is clicked.
+
+MouseEventHandler
+
+
+
+ | \- | \- |
+| prepend | 
+
+Content for the prepend slot.
+
+ReactNode
+
+
+
+ | \- | \- |