@iress-oss/ids-mcp-server 0.0.1-dev.0

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

@@ -0,0 +1,494 @@
+[](#card)Card
+=============
+
+Overview
+--------
+
+Cards are used to group small, related pieces of information into one digestible unit.
+
+Read more
+
+A single card will typically include a few different types of media, such as an image, a title, a synopsis, a call-to-action button or sub actions buttons - all associated with the same concept.
+
+Cards can be configured in a variety of ways. You can use the render props (slots) if you want to create a structured layout, or you can create a custom card with your own markup if you need more flexibility.
+
+I'm a card
+
+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; }
+
+<IressCard\>
+  I'm a card
+</IressCard\>
+
+Copy
+
+[](#examples)Examples
+---------------------
+
+### [](#simple-cards)Simple cards
+
+All slots and props for card are optional. You can create a simple card by adding some content to the default slot.
+
+I'm a simple card
+
+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; }
+
+<IressCard\>
+  I'm a simple card
+</IressCard\>
+
+Copy
+
+### [](#padding)Padding
+
+Padding can be controlled using the `padding` prop. It can be set to `none`, `sm`, `md` or `lg`. It defaults to `md`.
+
+I’m a card with none padding
+
+I’m a card with sm padding
+
+I’m a card with md padding
+
+I’m a card with lg padding
+
+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; }
+
+<div className\="iress-u-stack iress--gutter--md"\>
+  <IressCard padding\="none"\>
+    I’m a card with none padding  </IressCard\>
+  <IressCard padding\="sm"\>
+    I’m a card with sm padding  </IressCard\>
+  <IressCard padding\="md"\>
+    I’m a card with md padding  </IressCard\>
+  <IressCard padding\="lg"\>
+    I’m a card with lg padding  </IressCard\>
+</div\>
+
+Copy
+
+### [](#stretch)Stretch
+
+The `stretch` prop can be used to stretch the card to fill its container.
+
+I’m a stretched card
+
+I’m a card with lots of content. Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah.
+
+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; }
+
+<IressRow
+  gutter\="md"
+  verticalAlign\="stretch"
+\>
+  <IressCol\>
+    <IressCard stretch\>
+      I’m a stretched card    </IressCard\>
+  </IressCol\>
+  <IressCol\>
+    <IressCard\>
+      I’m a card with lots of content. Blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah.    </IressCard\>
+  </IressCol\>
+</IressRow\>
+
+Copy
+
+### [](#selected)Selected
+
+Setting the `selected` prop highlights the card, usually to allow selection in a list.
+
+I'm a selected card
+
+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; }
+
+<IressCard selected\>
+  I'm a selected card
+</IressCard\>
+
+Copy
+
+[](#render-props-slots)Render props (slots)
+-------------------------------------------
+
+If you're coming from v4 or earlier, you might be used to slots. In v5, we've replaced slots with render props which align with the React API. Render props allow you to create a structured layout for your card, while still having the flexibility to add custom content. They are simply functions that return JSX, so you can pass any component you like.
+
+However, please be diligent as the component you use may not fit withing the confines of the `IressCard` layout.
+
+### [](#prepend)Prepend
+
+Use the `prepend` prop to add content to the left side of the card.
+
+I'm a card using the prepend render prop
+
+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; }
+
+<IressCard prepend\={<IressIcon name\="star" />}\>
+  I'm a card using the prepend render prop
+</IressCard\>
+
+Copy
+
+### [](#top-right)Top Right
+
+Use the `topRight` prop to add content to the top right of the card. This is useful for adding a badge, icon, or an actions menu.
+
+More actions in here
+
+I'm a card using the topRight render prop
+
+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; }
+
+<IressCard topRight\={<IressPopover activator\={<IressButton\><IressIcon name\="ellipsis-v" size\="lg"/></IressButton\>} align\="bottom-end"\><IressPanel\>More actions in here</IressPanel\></IressPopover\>}\>
+  I'm a card using the topRight render prop
+</IressCard\>
+
+Copy
+
+### [](#heading)Heading
+
+Use the `heading` prop to add a header to the card. The header can be any component you like, but it is designed to support a simple heading element, optionally wrapped with a link.
+
+**Note:** `headingText` and `headingLevel` props have been replaced with the `heading` render prop to give you more control over the heading element and its content. To use the previous behaviour, you can pass a string which will automatically create a `h2` element, or pass a `h*` element with the text as a child.
+
+### Welcome to Iress!
+
+I'm a card using the heading render prop
+
+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; }
+
+<IressCard heading\={<h3\>Welcome to Iress!</h3\>}\>
+  I'm a card using the heading render prop
+</IressCard\>
+
+Copy
+
+### [](#media)Media
+
+Use the `media` prop to add media to the card. The media can be any component you like, but it is designed to support an image or video.
+
+![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
+
+I'm a card using the media render prop
+
+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; }
+
+<IressCard media\={<img alt\="A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground" src\="https://www.iress.com/media/images/media-contact.width-600.png" width\="250"/>}\>
+  I'm a card using the media render prop
+</IressCard\>
+
+Copy
+
+### [](#content)Content
+
+Use the `content` prop to add content to the card. The content can be any component you like, but it is designed to support simple text based elements.
+
+Find out all the onboarding material you need  
+[with this easy guide](https://iress.com).
+
+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; }
+
+<IressCard\>
+  <IressText\>
+    Find out all the onboarding material you need{' '}
+    <br />
+    <a href\="https://iress.com"\>
+      with this easy guide    </a\>
+    .  </IressText\>
+</IressCard\>
+
+Copy
+
+### [](#footer)Footer
+
+Use the `footer` prop to add a footer to the card. The footer can be any component you like, but it is designed to support buttons.
+
+I'm a card using the footer render prop
+
+#new-starter#first-day
+
+NEW
+
+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; }
+
+<IressCard footer\={<IressInline gutter\="sm" horizontalAlign\="between"\><IressInline gutter\="sm"\><IressBadge mode\="background-default" pill\>#new-starter</IressBadge\><IressBadge mode\="background-default" pill\>#first-day</IressBadge\></IressInline\><IressBadge mode\="positive"\>NEW</IressBadge\></IressInline\>}\>
+  I'm a card using the footer render prop
+</IressCard\>
+
+Copy
+
+### [](#all-slots)All slots
+
+You can use all the slots together to create a custom card layout.
+
+prepend
+
+media
+
+heading
+
+topRight
+
+children
+
+footer
+
+* * *
+
+More actions in here
+
+![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
+
+### Welcome to Iress!
+
+Find out all the onboarding material you need  
+[with this easy guide](https://iress.com).
+
+#new-starter#first-day
+
+NEW
+
+More actions in here
+
+![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
+
+### Welcome to Iress!
+
+Find out all the onboarding material you need  
+[with this easy guide](https://iress.com).
+
+#new-starter#first-day
+
+NEW
+
+More actions in here
+
+![A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground](https://www.iress.com/media/images/media-contact.width-600.png)
+
+### Welcome to Iress!
+
+Find out all the onboarding material you need  
+[with this easy guide](https://iress.com).
+
+#new-starter#first-day
+
+NEW
+
+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 supportedCardSlots \= {
+  prepend: <IressIcon name\="star" />,
+  media: (
+    <img
+      src\="https://www.iress.com/media/images/media-contact.width-600.png"
+      width\="250"
+      alt\="A man in an Iress branded t-shirt smiles at the camera while two female colleagues have a discussion in the foreground"
+    />
+  ),
+  heading: <h3\>Welcome to Iress!</h3\>,
+  topRight: (
+    <IressPopover
+      align\="bottom-end"
+      activator\={
+        <IressButton\>
+          <IressIcon name\="ellipsis-v" size\="lg" />
+        </IressButton\>
+      }
+    \>
+      <IressPanel\>More actions in here</IressPanel\>
+    </IressPopover\>
+  ),
+  children: (
+    <IressText\>
+      Find out all the onboarding material you need <br />
+      <a href\="https://iress.com"\>with this easy guide</a\>.
+    </IressText\>
+  ),
+  footer: (
+    <IressInline gutter\="sm" horizontalAlign\="between"\>
+      <IressInline gutter\="sm"\>
+        <IressBadge pill mode\="background-default"\>
+          #new-starter        </IressBadge\>
+        <IressBadge pill mode\="background-default"\>
+          #first-day        </IressBadge\>
+      </IressInline\>
+      <IressBadge mode\="positive"\>NEW</IressBadge\>
+    </IressInline\>
+  ),
+};
+const SUPPORTED\_CARD\_SLOTS \= Object.keys(supportedCardSlots);
+type SupportedCardSlots \= keyof typeof supportedCardSlots;
+
+export const CardAllSlots \= () \=> {
+  const \[show, setShow\] \= useState({
+    children: true,
+    prepend: false,
+    media: true,
+    heading: true,
+    topRight: true,
+    footer: true,
+  });
+  const filteredArgs \= Object.fromEntries(
+    Object.entries(supportedCardSlots).filter(
+      (\[key\]) \=> show\[key as SupportedCardSlots\] || !(key in show),
+    ),
+  );
+  return (
+    <IressContainer\>
+      <IressInline gutter\="md"\>
+        {SUPPORTED\_CARD\_SLOTS.map((slot) \=> (
+          <IressToggle
+            key\={slot}
+            checked\={show\[slot as never\]}
+            onChange\={(checked) \=> {
+              setShow({ ...show, \[slot\]: checked });
+            }}
+          \>
+            {slot}
+          </IressToggle\>
+        ))}
+      </IressInline\>
+      <hr />
+      <IressRow gutter\="md"\>
+        <IressCol\>
+          <IressCard {...filteredArgs} />
+        </IressCol\>
+        <IressCol\>
+          <IressCard {...filteredArgs} />
+        </IressCol\>
+        <IressCol\>
+          <IressCard {...filteredArgs} />
+        </IressCol\>
+      </IressRow\>
+    </IressContainer\>
+  );
+};
+
+Copy
+
+[](#clickable-cards)Clickable cards
+-----------------------------------
+
+Note: The `clickable` prop has been deprecated in favour of using component variations, or the `onClick` prop.
+
+### [](#heading-only)Heading only
+
+Since the `heading` prop now renders the component you give it, you have full control over the content of the `heading`. This means you can add pass it a heading with a link.
+
+[Clickable heading](https://iress.com)
+--------------------------------------
+
+I'm a card with a clickable heading. NEVER use me when the whole card is clickable.
+
+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; }
+
+<IressCard heading\={<h2\><a href\="https://iress.com"\>Clickable heading</a\></h2\>}\>
+  I'm a card with a clickable heading. NEVER use me when the whole card is clickable.
+</IressCard\>
+
+Copy
+
+### [](#whole-card)Whole card
+
+The whole card can be made clickable by passing an `onClick` prop. All the appropriate styling will be added as well.
+
+It's recommended to add `role="button"` and `tabindex="0"` to the card to make it clear to screen readers that the card is clickable.
+
+I am a card with an onClick handler. Click me to see what happens.
+
+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; }
+
+<IressCard
+  onClick\={() \=> alert("Card clicked")}
+  onKeyDown\={() \=> alert("Key down on card (for keyboard users)")}
+  role\="button"
+  tabIndex\={0}
+\>
+  I am a card with an onClick handler. Click me to see what happens.
+</IressCard\>
+
+Copy
+
+### [](#links-and-buttons)Links and Buttons
+
+To simplify the process of making the whole card clickable, you can use the `IressLinkCard` and `IressButtonCard` components. These components look exactly the same as the `IressCard` component, however their base tags are different, allowing you to use them exactly like you would a html link and button.
+
+**Note:** These components replace the `button`, `clickable` and `href` props. You no longer need `button` and `clickable`, as these are automatically inferred. To mimic the `href` prop, simply change the component you are using to `IressLinkCard`.
+
+I am a card with a button element
+
+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; }
+
+<IressButtonCard
+  onClick\={() \=> alert("Card clicked")}
+  type\="button"
+\>
+  I am a card with a button element
+</IressButtonCard\>
+
+Copy
+
+[I am a card with an anchor element](https://iress.com)
+
+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; }
+
+<IressLinkCard
+  href\="https://iress.com"
+  target\="\_blank"
+\>
+  I am a card with an anchor element
+</IressLinkCard\>
+
+Copy
+
+On this page
+
+*   [Overview](#overview)
+*   [Props](#props)
+*   [Examples](#examples)
+    *   [Simple cards](#simple-cards)
+    *   [Padding](#padding)
+    *   [Stretch](#stretch)
+    *   [Selected](#selected)
+*   [Render props (slots)](#render-props-slots)
+    *   [Prepend](#prepend)
+    *   [Top Right](#top-right)
+    *   [Heading](#heading)
+    *   [Media](#media)
+    *   [Content](#content)
+    *   [Footer](#footer)
+    *   [All slots](#all-slots)
+*   [Clickable cards](#clickable-cards)
+    *   [Heading only](#heading-only)
+    *   [Whole card](#whole-card)
+    *   [Links and Buttons](#links-and-buttons)

package/generated/docs/components-card-recipes-docs.md

@@ -0,0 +1,89 @@
+[](#recipes)Recipes
+===================
+
+Under construction
+------------------
+
+This documentation is still under construction. If you have any questions, please reach out to the design system team.
+
+[](#compose-functions)Compose functions
+---------------------------------------
+
+Beneath the surface, the `IressCard` component uses a compose helper to manage its styling. These helpers are exposed as `composeIDSCard` and `composeIDSCardSlots` and can be used to create custom cards.
+
+They accept a subset of `IressCardProps`. They also accept an optional second argument if you want to override the default styles with your own CSS module, or other `style` object (eg. CSS-in-JS).
+
+### [](#use-cases)Use cases
+
+1.  You are using a third-party routing library with its own `Link` component and want to use it as a clickable card. This is similar to `IressButtonCard` and `IressLinkCard`.
+2.  You need a different base component to meet your requirements, such as `<article />` when displaying on a news page.
+3.  You need to add some additional styling to the internals of the card, such as a custom footer or a custom image.
+
+Article mark-up, with custom classes for border
+-----------------------------------------------
+
+Prepend
+
+TopRight
+
+Media
+
+Heading
+-------
+
+Children (default slot)
+
+Footer
+
+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; }
+
+import {
+  CardSlotClass,
+  composeIDSCard,
+  composeIDSCardSlots,
+  IressCardProps,
+  IressStack,
+  IressText,
+} from '@iress-oss/ids-components';
+import styles from '@iress-storybook/styles.module.scss';
+export const CardUsingHook \= () \=> {
+  const cardProps \= composeIDSCard({
+  prepend: 'Prepend',
+  heading: 'Heading',
+  topRight: 'TopRight',
+  media: 'Media',
+  children: 'Children (default slot)',
+  footer: 'Footer',
+});
+  const cardChildren \= composeIDSCardSlots({
+  prepend: 'Prepend',
+  heading: 'Heading',
+  topRight: 'TopRight',
+  media: 'Media',
+  children: 'Children (default slot)',
+  footer: 'Footer',
+}, {
+    ...Object.fromEntries(
+      Object.entries(CardSlotClass).map((\[key, value\]) \=> \[
+        key,
+        \`${value} ${styles.addBorder}\`,
+      \]),
+    ),
+  });
+  return (
+    <IressStack gutter\="md"\>
+      <IressText element\="h2"\>
+        Article mark-up, with custom classes for border      </IressText\>
+      <article {...cardProps}\>{cardChildren}</article\>
+    </IressStack\>
+  );
+};
+
+Copy
+
+On this page
+
+*   [Compose functions](#compose-functions)
+    *   [Use cases](#use-cases)