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

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

@@ -6,6 +6,14 @@ Overview
 
 Slideouts are used to show additional information or to allow users to perform secondary tasks without leaving their normal workflow.
 
+* * *
+
+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.
+
 Read more
 
 [](#use-a-slideout-when)Use a slideout when:
@@ -14,7 +22,7 @@ Read more
 *   Providing supplemental tasks that require the underlying page to still be visible
 *   Providing non-essential information related to the underlying page
 
-Show slideout
+Toggle slideout
 
 Hide code
 
@@ -22,18 +30,18 @@ Hide code
 
 const Story \= () \=> {
   const { showSlideout } \= useSlideout();
-const SLIDEOUT\_ID \= 'storybook-slideout';
-return (
-  <\>
+      const SLIDEOUT\_ID \= 'storybook-slideout';
+      return (
+        <\>
   <IressButton onClick\={() \=> showSlideout(SLIDEOUT\_ID)}\>
-    Show slideout  </IressButton\>
+    Toggle slideout  </IressButton\>
   <IressSlideout
     footer\="Footer slot"
     id\="storybook-slideout"
   \>
     Slideout content  </IressSlideout\>
 </\>
-);
+      );
 };
   
 export const App \= () \=> (
@@ -44,6 +52,539 @@ export const App \= () \=> (
 
 Copy
 
+[](#props)Props
+---------------
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| bg | 
+**`bg`** sets the background color of an element using the `background-color` css property using the color tokens in the design system.
+
+We recommend using the following token values for best background contrast:
+
+*   `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
+
+ResponsiveProp<ColorToken> | undefined
+
+ | \- | Set object |
+| borderRadius | 
+
+The **`border-radius`** CSS property rounds the corners of an element's outer border edge using the radius tokens in the design system.
+
+| Chrome | Firefox | Safari | Edge | IE |
+| --- | --- | --- | --- | --- |
+| **4** | **4** | **5** | **12** | **9** |
+| 1 _\-x-_ |  | 3 _\-x-_ |  |  |
+
+ResponsiveProp<RadiusToken> | undefined
+
+ | \- | Set object |
+| children | 
+
+Content to be displayed within the slideout.
+
+ReactNode
+
+
+
+ | \- | 
+
+"Slideout content"
+
+ |
+| closeText | 
+
+Screenreader text for close button.
+
+stringundefined
+
+
+
+ | 
+
+Close
+
+ | Set object |
+| 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
+
+ResponsiveProp<ColorToken> | undefined
+
+ | \- | Set object |
+| container | 
+
+The container element to render the slideout into. By default, the slideout will render at the end of the document body.
+
+FloatingUIContainerundefined
+
+
+
+ | \- | Set object |
+| defaultShow | 
+
+When set to `true` the slideout will be visible. Use for uncontrolled slideouts.
+
+booleanundefined
+
+
+
+ | 
+
+false
+
+ | Set object |
+| eleToPush | 
+
+The element that needs to be pushed relative to the slideout. This can be a string selector to match an existing element in the DOM, a html element, or a React reference. Will be ignored if `mode` is not set to `push` or if element does not exist.
+
+string | HTMLElement | MutableRefObject<HTMLElement | null> | undefined
+
+ | \- | 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 |
+| footer | 
+
+Panel to place slideout controls.
+
+ReactNode
+
+
+
+ | \- | 
+
+"Footer slot"
+
+ |
+| heading | 
+
+Sets the heading for the slideout. If passed an element, it will render the element with an id, to ensure its connection to the slideout.
+
+string | ReactElement<any, string | JSXElementConstructor<any>> | undefined
+
+ | \- | 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.
+
+ResponsiveProp<boolean> | undefined
+
+ | \- | Set object |
+| id | 
+
+Unique ID for the slideout. Use if you would like to open this slideout from anywhere in your app using the `useSlideout` hook.
+
+stringundefined
+
+
+
+ | \- | 
+
+"storybook-slideout"
+
+ |
+| 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.
+
+ResponsiveProp<"elevation.raised" | "elevation.floating" | "elevation.overflow" | "elevation.focus" | "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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | Set object |
+| mode | 
+
+Sets how the Slideout interacts with the content of the page. `overlay` overlays the page content, obscuring the content below. `push` will push the element (specified by `eleToPush`) across the page. `push` will revert back to `overlay` if `eleToPush` is not specified or if the screen size < 1200px.
+
+"overlay""push"undefined
+
+
+
+ | 
+
+overlay
+
+ | 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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<SpacingToken | "auto"> | undefined
+
+ | \- | 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 |
+| onEntered | 
+
+Emitted when the slideout has opened.
+
+(() => void) | undefined
+
+ | \- | \- |
+| onExited | 
+
+Emitted when the slideout has closed.
+
+(() => void) | undefined
+
+ | \- | \- |
+| onShowChange | 
+
+Emitted when the slideout has opened or closed internally. Use for controlled slideouts.
+
+((show: boolean, reason?: OpenChangeReason | undefined) => void) | undefined
+
+ | \- | \- |
+| onStatus | 
+
+Emitted when the slideout has mounted, unmounted, opened or closed. Open and close occur before animation begins.
+
+((status: "initial" | "open" | "close" | "unmounted") => void) | undefined
+
+ | \- | \- |
+| 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | Set object |
+| position | 
+
+Position of the slideout relative to the page. `left` or `right`.
+
+"left""right"undefined
+
+
+
+ | 
+
+right
+
+ | 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | 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 |
+
+ResponsiveProp<"xs" | "sm" | "md" | "lg" | "xl" | "none" | "spacing.000" | "spacing.050" | "spacing.100" | "spacing.150" | "spacing.200" | "spacing.250" | "spacing.300" | "spacing.350" | ... 9 more ... | "slider.tick"> | undefined
+
+ | \- | Set object |
+| show | 
+
+When set to `true` the slideout will be visible. Use for controlled slideouts.
+
+booleanundefined
+
+
+
+ | \- | \- |
+| size | 
+
+Accepts a single `SlideoutSize`. Slideouts will display at 100% for mobile screens (<576px).
+
+"sm""md"undefined
+
+
+
+ | 
+
+sm
+
+ | 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 }`
+
+ResponsiveProp<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** |
+
+ResponsiveProp<"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.
+
+ResponsiveProp<"typography.heading.1" | "typography.heading.2" | "typography.heading.3" | "typography.heading.4" | "typography.heading.5" | "typography.body.sm" | "typography.body.sm.regular" | ... 10 more ... | "typography.code"> | undefined
+
+ | \- | 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** |
+
+ResponsiveProp<"auto" | SizeToken | "screen" | "1/2" | "1/3" | "2/3" | "1/4" | "2/4" | "3/4" | "1/5" | "2/5" | "3/5" | "4/5" | "1/6" | "2/6" | "3/6" | "4/6" | "5/6" | "1/12" | "2/12" | ... 8 more ... | "11/12"> | undefined
+
+ | \- | Set object |
+
 [](#controlling-the-slideout)Controlling the slideout
 -----------------------------------------------------
 
@@ -122,6 +663,27 @@ const SlideoutWithTrigger \= ({
 
 Copy
 
+#### [](#provider-api)Props
+
+These are some settings you can use to customise the provider, such as setting where the slideouts are rendered in the DOM.
+
+| Name | Description | Default | Control |
+| --- | --- | --- | --- |
+| children | 
+\-
+
+ | \- | \- |
+| container | 
+
+The container element to render the slideout into. By default, the slideout will render at the end of the document body.
+
+FloatingUIContainerundefined
+
+
+
+ | \- | \- |
+| Show Storybook only itemsStorybook only | Show Storybook only items |
+
 [](#examples)Examples
 ---------------------
 
@@ -137,53 +699,58 @@ Hide code
 
 const Story \= () \=> {
   const { showSlideout } \= useSlideout();
-const SLIDEOUT\_ID \= 'storybook-slideout';
-return (
-  <IressInline gutter\="md"\>
-  <IressButton onClick\={() \=> showSlideout("overlay")}\>
-    Overlay slideout  </IressButton\>
-  <IressSlideout
-    footer\=""
-    id\="overlay"
-    mode\="overlay"
-  \>
-    <h2\>
-      Overlay    </h2\>
-    For most situations{' '}
-    <code\>
-      overlay    </code\>
-    {' '}will be what you need, which is why this is the default behaviour. You do not need to specify the mode if you want your slideout to sit on top of the page.
-  </IressSlideout\>
-  <IressButton onClick\={() \=> showSlideout("push")}\>
-    Push slideout  </IressButton\>
-  <IressSlideout
-    eleToPush\="#storybook-docs"
-    footer\=""
-    id\="push"
-    mode\="push"
-  \>
-    <IressText\>
+      const SLIDEOUT\_ID \= 'storybook-slideout';
+      return (
+        <IressPanel bg\="alt"\>
+  <IressInline gap\="md"\>
+    <IressButton onClick\={() \=> showSlideout("overlay")}\>
+      Overlay slideout    </IressButton\>
+    <IressSlideout
+      footer\=""
+      id\="overlay"
+      mode\="overlay"
+    \>
       <h2\>
-        Push      </h2\>
-      <p\>
-        If you have a data-heavy screen where you need all of the data to be visible when the slideout is open, use{' '}
-        <code\>
-          push        </code\>
-        . To allow push to work you will need to supply the ID of the element that needs to be pushed via the{' '}
-        <code\>
-          eleToPush        </code\>
-        {' '}prop. If the ID is not supplied, or the element cannot be found, the slideout will revert to{' '}
-        <code\>
-          overlay        </code\>
-        {' '}behaviour.
-      </p\>
-      <p\>
-        {\`Be aware though that push will only work on larger screens (>1200px); on smaller screens the slideout will overlay the content.\`}
-      </p\>
-    </IressText\>
-  </IressSlideout\>
-</IressInline\>
-);
+        Overlay      </h2\>
+      For most situations{' '}
+      <code\>
+        overlay      </code\>
+      {' '}will be what you need, which is why this is the default behaviour. You do not need to specify the mode if you want your slideout to sit on top of the page.
+    </IressSlideout\>
+    <IressButton onClick\={() \=> showSlideout("push")}\>
+      Push slideout    </IressButton\>
+    <IressSlideout
+      eleToPush\="#storybook-docs, html"
+      footer\=""
+      id\="push"
+      mode\="push"
+    \>
+      <IressText\>
+        <h2\>
+          Push        </h2\>
+        <p\>
+          If you have a data-heavy screen where you need all of the data to be visible when the slideout is open, use{' '}
+          <code\>
+            push          </code\>
+          . To allow push to work you will need to supply the ID of the element that needs to be pushed via the{' '}
+          <code\>
+            eleToPush          </code\>
+          {' '}prop. If the ID is not supplied, or the element cannot be found, the slideout will revert to{' '}
+          <code\>
+            overlay          </code\>
+          {' '}behaviour.
+        </p\>
+        <p\>
+          {\`Be aware though that push will only work on larger screens (>1200px); on smaller screens the slideout will overlay the content.\`}
+        </p\>
+        <IressPanel bg\="alt"\>
+          <CurrentBreakpoint />
+        </IressPanel\>
+      </IressText\>
+    </IressSlideout\>
+  </IressInline\>
+</IressPanel\>
+      );
 };
   
 export const App \= () \=> (
@@ -207,17 +774,13 @@ Hide code
 const Slideouts \= () \=> {
   const { showSlideout } \= useSlideout();
   return (
-    <IressInline gutter\="md"\>
-      {SLIDEOUT\_POSITIONS.map((position) \=> (
-        <\>
-          <IressButton onClick\={() \=> showSlideout(position)}\>
-            {position}
-          </IressButton\>
-          <IressSlideout id\={position} position\={position}\>
-            Slideout opened on the {position}
-          </IressSlideout\>
-        </\>
-      ))}
+    <IressInline gap\="md" horizontalAlign\="between"\>
+      <IressButton onClick\={() \=> showSlideout('right')}\>right</IressButton\>
+      <IressSlideout id\="right" position\="right"\>
+        Slideout opened on the right      </IressSlideout\>
+      <IressButton onClick\={() \=> showSlideout('left')}\>left</IressButton\>
+      <IressSlideout id\="left" position\="left"\>
+        Slideout opened on the left      </IressSlideout\>
     </IressInline\>
   );
 };
@@ -229,48 +792,11 @@ export const SlideoutPositions \= () \=> (
 
 Copy
 
-### [](#backdrop)Backdrop
-
-Slideouts can be used with or without a backdrop. Using a backdrop places more emphasis on the slideout, but prevents users from accessing content on the rest of the page. If your users need to interact with page content (for example to copy information), don't use a backdrop.
-
-The slideout backdrop works in the same way as the modal backdrop; clicking on the backdrop will close the slideout.
-
-Show slideout with backdrop
-
-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; }
-
-const Story \= () \=> {
-  const { showSlideout } \= useSlideout();
-const SLIDEOUT\_ID \= 'storybook-slideout';
-return (
-  <\>
-  <IressButton onClick\={() \=> showSlideout(SLIDEOUT\_ID)}\>
-    Show slideout with backdrop  </IressButton\>
-  <IressSlideout
-    backdrop
-    footer\="Footer slot"
-    id\="storybook-slideout"
-  \>
-    Slideout content  </IressSlideout\>
-</\>
-);
-};
-  
-export const App \= () \=> (
-  <IressSlideoutProvider\>
-        <Story />
-      </IressSlideoutProvider\>
-);
-
-Copy
-
 ### [](#size)Size
 
-The width of your slideout can be set using the `size` prop. By default it is `sm`, but it can be made larger by setting `size` to `md` or `lg`.
+The width of your slideout can be set using the `size` prop. By default it is `sm`, but it can be made larger by setting `size` to `md`.
 
-smmdlg
+smmd
 
 Hide code
 
@@ -279,14 +805,13 @@ Hide code
 const Slideouts \= () \=> {
   const { showSlideout } \= useSlideout();
   return (
-    <IressInline gutter\="md"\>
-      {SLIDEOUT\_SIZES.map((size) \=> (
-        <\>
-          <IressButton onClick\={() \=> showSlideout(size)}\>{size}</IressButton\>
-          <IressSlideout id\={size} size\={size}\>
-            {size} slideout          </IressSlideout\>
-        </\>
-      ))}
+    <IressInline gap\="spacing.400"\>
+      <IressButton onClick\={() \=> showSlideout('sm')}\>sm</IressButton\>
+      <IressSlideout id\="sm" size\="sm"\>
+        Small slideout      </IressSlideout\>
+      <IressButton onClick\={() \=> showSlideout('md')}\>md</IressButton\>
+      <IressSlideout id\="md" size\="md"\>
+        Medium slideout      </IressSlideout\>
     </IressInline\>
   );
 };
@@ -300,37 +825,11 @@ Copy
 
 ### [](#padding)Padding
 
-Slideout padding follows the panel padding convention. It can be set to either `none`, `sm`, `md` or `lg`, and defaults to `md` if not set.
-
-nonesmmdlg
-
-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; }
+Slideout padding now is a global styling prop.
 
-const Slideouts \= () \=> {
-  const { showSlideout } \= useSlideout();
-  return (
-    <IressInline gutter\="md"\>
-      {PADDING\_SIZES.map((padding) \=> (
-        <\>
-          <IressButton onClick\={() \=> showSlideout(padding)}\>
-            {padding}
-          </IressButton\>
-          <IressSlideout id\={padding} padding\={padding}\>
-            Slideout opened with {padding} padding          </IressSlideout\>
-        </\>
-      ))}
-    </IressInline\>
-  );
-};
-export const SlideoutPaddings \= () \=> (
-  <IressSlideoutProvider\>
-    <Slideouts />
-  </IressSlideoutProvider\>
-);
+[](/?path=/docs/styling-props-spacing--docs#padding)
 
-Copy
+[Learn more](/?path=/docs/styling-props-spacing--docs#padding)
 
 ### [](#footer)Footer
 
@@ -344,9 +843,9 @@ Hide code
 
 const Story \= () \=> {
   const { showSlideout } \= useSlideout();
-const SLIDEOUT\_ID \= 'storybook-slideout';
-return (
-  <\>
+      const SLIDEOUT\_ID \= 'storybook-slideout';
+      return (
+        <\>
   <IressButton onClick\={() \=> showSlideout(SLIDEOUT\_ID)}\>
     Show slideout with footer  </IressButton\>
   <IressSlideout
@@ -355,7 +854,7 @@ return (
   \>
     Slideout content  </IressSlideout\>
 </\>
-);
+      );
 };
   
 export const App \= () \=> (
@@ -368,9 +867,9 @@ Copy
 
 ### [](#absolute-position-slideouts)Absolute position slideouts
 
-By default, slideout is set to `position: fixed` which means it will appear from the edge of the browser window. By setting the `--iress-position` css variable to `absolute` the slideout can appear from the edge of its closest relative positioned container. You will also need to set the `container` prop to the a reference of the relatively positioned container, so it can appear in the correct place in the DOM.
+By default, slideout is set to `position: fixed` which means it will appear from the edge of the browser window. By setting the `position: 'absolute'` in custom inline style, the slideout can appear from the edge of its closest relative positioned container. You will also need to set the `container` prop to the a reference of the relatively positioned container, so it can appear in the correct place in the DOM.
 
-If you're using an absolutely positioned slideout you may also want to change the vertical and horizontal positioning. By default this will be the top left or top right of the container, but you can use `--iress-offset-top` and `--iress-initial-offset` to adjust that if you need to.
+If you're using an absolutely positioned slideout you may also want to change the vertical and horizontal positioning. By default this will be the top left or top right of the container, but you can use inline style `style={{top: '30px', height: 'calc(100% - 30px)'}}` to adjust that if you need to.
 
 Show slideout
 
@@ -390,18 +889,18 @@ import {
   IressSlideoutProps,
 } from '@iress-oss/ids-components';
 import { useRef, useState } from 'react';
+import { cssVars } from '@iress-oss/ids-tokens';
 export const AbsolutePositionSlideout \= () \=> {
   const \[show, setShow\] \= useState(false);
   const containerRef \= useRef<HTMLDivElement | null\>(null);
   return (
-    <IressStack gutter\="md"\>
+    <IressStack gap\="md"\>
       <IressButton onClick\={() \=> setShow(true)}\>Show slideout</IressButton\>
       <div
         ref\={containerRef}
         style\={{
           height: '300px',
-          border:
-            '1px solid var(--iress-g-border-color, var(--iress-default-border-color))',
+          border: \`1px solid ${cssVars.colour.neutral\[30\]}\`,
           padding: '1rem',
           overflow: 'hidden',
           position: 'relative',
@@ -426,7 +925,7 @@ export const AbsolutePositionSlideout \= () \=> {
           onShowChange\={setShow}
           style\={
             {
-              '--iress-position': 'absolute',
+              position: 'absolute',
             } as never
           }
         />
@@ -527,7 +1026,6 @@ On this page
 *   [Examples](#examples)
     *   [Modes](#modes)
     *   [Position](#position)
-    *   [Backdrop](#backdrop)
     *   [Size](#size)
     *   [Padding](#padding)
     *   [Footer](#footer)