@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-skiplink-docs.md

@@ -0,0 +1,220 @@
+SkipLink
+========
+
+Overview
+--------
+
+The skip link component allows keyboard users to quickly bypass the top-level navigation links and jump to the main content on a page.
+
+* * *
+
+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-skiplink--skip-link)
+
+```
+
+<IressContainer\>
+  <IressSkipLink
+    href\="#main"
+    id\="skip-link"
+  />
+  <main
+    id\="main"
+    tabIndex\={\-1}
+  \>
+    <IressPanel\>
+      <p\>
+        This is where the main content{' '}
+        <code\>
+          id="main"        </code\>
+        {' '}of the application is located. It is important that whatever your skip link is targeting is{' '}
+        <strong\>
+          focusable        </strong\>
+        . If its a non-interactive element, this can be done by adding{' '}
+        <code\>
+          tabindex="-1"        </code\>
+        {' '}to the element.
+      </p\>
+      <p\>
+        The skip link is{' '}
+        <a
+          href\="#skip-link"
+          onClick\={(e) \=> {e.preventDefault();document.getElementById("skip-link")?.focus();}}
+        \>
+          hidden until it is focused        </a\>
+        .      </p\>
+    </IressPanel\>
+  </main\>
+</IressContainer\>
+
+```
+
+Props
+-----
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| active | 
+Sets the active state of the button, usually used to indicate the button 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 action of this button.
+
+ReactNode
+
+
+
+ | 
+
+'Skip to content'
+
+ | Set object |
+| element | 
+
+Change the component that will be rendered as the button, 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 |
+| fluid | 
+
+If `true`, the button will stretch to fill it's container. The prop is responsive, so you can set the breakpoint(s) at which the button will be fluid.
+
+All breakpoints: `fluid={true}` Up to a specific breakpoint: `fluid={{ base: true, md: false }}`
+
+union
+
+
+
+ | \- | 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
+
+
+
+ | \- | 
+
+"#main"
+
+ |
+| id | 
+
+string
+
+
+
+ | \- | skip-link |
+| loading | 
+
+When true, button is in loading state. If provided a string, will be used as the loading text for screen readers.
+
+union
+
+
+
+ | \- | Set object |
+| mode | 
+
+Style of the button.
+
+*   Primary: Used for the main action on a page. Usually only used once per screen.
+*   Secondary: Used for secondary actions on a page, often an action on multiple `IressPanel`s. Can used multiple times per screen.
+*   Tertiary: Used for tertiary actions on a page, often the secondary action on multiple `IressPanel`s. Can used multiple times per screen.
+
+**Migrating to version 6**
+
+*   `link` mode has been removed. If it is an action, use the `tertiary` mode. If it is a link inside a paragraph, use the new `IressLink` component instead.
+*   `danger` has been removed. Please use the `status` prop instead.
+*   `positive` and `success` have been removed. Please use the `status` prop instead.
+
+union
+
+
+
+ | \- | 
+
+primarysecondarytertiary
+
+ |
+| noWrap | 
+
+Prevents text wrapping if set to true.
+
+boolean
+
+
+
+ | \- | Set boolean |
+| onClick | 
+
+Emitted when the menu item is clicked.
+
+MouseEventHandler
+
+
+
+ | \- | Set object |
+| prepend | 
+
+Content for the prepend slot.
+
+ReactNode
+
+
+
+ | \- | Set object |
+| status | 
+
+An optional status to assign to the button.
+
+*   `success`: Indicates a successful or positive action.
+*   `danger`: Indicates a dangerous or potentially negative action.
+
+union
+
+
+
+ | \- | 
+
+successdanger
+
+ |
+| value | 
+
+The value of the button, when used in `IressButtonGroup`.
+
+FormControlValue
+
+
+
+ | \- | Set object |
+
+Behaviour
+---------
+
+*   The skip link component is visually hidden until it is tabbed to.