Skip to content

Commit

Permalink
docs(styles): update the documentation for multi input [ci visual] (#…
Browse files Browse the repository at this point in the history
…3175)

Co-authored-by: ynnenu <eniela.vela@sap.com>
  • Loading branch information
ynnenu and ynnenu committed Feb 21, 2022
1 parent bb8be87 commit deae154
Showing 1 changed file with 18 additions and 7 deletions.
25 changes: 18 additions & 7 deletions stories/multi-input/multi-input.stories.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@ export default {
title: 'Patterns/Multi Input',
parameters: {
description: `
The multi-input component is an opinionated composition of the \`input group\`, \`popover\`, \`checkbox\`, \`list\` and \`token\` components.
The \`popover\` is shared between the combobox and select components. Please see the \`select\` documentation for the complete list of modifiers,
That are also supported by the \`combobox\` component.
\`Multi Input\` allows users to enter multiple values which are displayed as a tokens.
It provides an editable input field for filtering the list, and a dropdown menu with a list of the available options.
Multi Input allows users to enter multiple values which are displayed as a tokens. It provides an editable input field for filtering the list, and a dropdown menu with a list of the available options.
If the entries are not validated by the application, users can also enter custom values.
##Usage
**Use the multi input if:**
- You want the user to select multiple ranges.
- The dataset to choose from is expected to increase over time.
- You need to provide the value help option to help users select or search multiple business objects.
- You want to enable users to add custom values.
`,
tags: ['f3', 'a11y', 'theme'],
components: [
Expand Down Expand Up @@ -227,7 +232,13 @@ export const CozyAndCompact = () => `<div style="display:flex;height:310px">

CozyAndCompact.parameters = {
docs: {
iframeHeight: 350
iframeHeight: 350,
description: {
story: `The multi-input component is a composition of
the \`input group\`, \`popover\`, \`checkbox\`, \`list\` and \`token\` components. It can be displayed in compact mode by adding
the \`--compact\` modifier class to the building blocks of the components.
`
}
}
};

Expand Down

0 comments on commit deae154

Please sign in to comment.