diff --git a/packages/web-react/src/components/Accordion/README.md b/packages/web-react/src/components/Accordion/README.md index a59b91689a..19bcf6fab6 100644 --- a/packages/web-react/src/components/Accordion/README.md +++ b/packages/web-react/src/components/Accordion/README.md @@ -198,12 +198,12 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Accordion component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Alert/README.md b/packages/web-react/src/components/Alert/README.md index c52b0bd39f..4144579b67 100644 --- a/packages/web-react/src/components/Alert/README.md +++ b/packages/web-react/src/components/Alert/README.md @@ -47,9 +47,9 @@ For detailed information see [Alert][alert] component. ⚠️ Please pay attention to the accessibility setting when Alert is dynamically displayed. In case you need to use the component as an information that requires the user's immediate attention, you can set `role="alert"` as an [additional attribute][readme-additional-attributes]. -## Dependencies +## Icons -The Alert component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [alert]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/src/scss/components/Alert/README.md @@ -58,4 +58,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Breadcrumbs/README.md b/packages/web-react/src/components/Breadcrumbs/README.md index aae910a56b..05299b3734 100644 --- a/packages/web-react/src/components/Breadcrumbs/README.md +++ b/packages/web-react/src/components/Breadcrumbs/README.md @@ -108,9 +108,9 @@ You can also use any of the existing [npm packages which deal with truncating th For detailed information see [Breadcrumbs][breadcrumbs] component. -## Dependencies +## Icons -The Breadcrumbs component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [breadcrumbs]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/src/scss/components/Breadcrumbs/README.md @@ -118,4 +118,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props [truncate-npm-search]: https://www.npmjs.com/search?q=truncate -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Button/README.md b/packages/web-react/src/components/Button/README.md index f0a0e52270..963e803691 100644 --- a/packages/web-react/src/components/Button/README.md +++ b/packages/web-react/src/components/Button/README.md @@ -55,9 +55,9 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Button component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [button]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web/src/scss/components/Button @@ -66,4 +66,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/ButtonLink/README.md b/packages/web-react/src/components/ButtonLink/README.md index da7e502dbf..2875b264fc 100644 --- a/packages/web-react/src/components/ButtonLink/README.md +++ b/packages/web-react/src/components/ButtonLink/README.md @@ -41,9 +41,9 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The ButtonLink component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [button]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web/src/scss/components/Button @@ -52,4 +52,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/FileUploader/README.md b/packages/web-react/src/components/FileUploader/README.md index 5f565eb29d..f798aa8fe5 100644 --- a/packages/web-react/src/components/FileUploader/README.md +++ b/packages/web-react/src/components/FileUploader/README.md @@ -502,9 +502,9 @@ and [escape hatches][readme-escape-hatches]. For detailed information see [FileUploader][file-uploader] component. -## Dependencies +## Icons -The FileUploader component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [button-element-docs]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button @@ -516,4 +516,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Header/README.md b/packages/web-react/src/components/Header/README.md index 2f97869532..0c2ba11f8a 100644 --- a/packages/web-react/src/components/Header/README.md +++ b/packages/web-react/src/components/Header/README.md @@ -579,9 +579,9 @@ const handleClose = () => setOpen(false); -## Dependencies +## Icons -The Header component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [mdn-a-element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a @@ -593,4 +593,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Item/README.md b/packages/web-react/src/components/Item/README.md index c5eb7fe5b4..2ac843ca86 100644 --- a/packages/web-react/src/components/Item/README.md +++ b/packages/web-react/src/components/Item/README.md @@ -108,9 +108,9 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Item component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [checkbox]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Checkbox/README.md @@ -119,4 +119,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Modal/README.md b/packages/web-react/src/components/Modal/README.md index 5c93dca89d..d58091f4fd 100644 --- a/packages/web-react/src/components/Modal/README.md +++ b/packages/web-react/src/components/Modal/README.md @@ -423,9 +423,9 @@ const handleClose = () => setOpen(false); ``` -## Dependencies +## Icons -The Modal component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [dictionary-alignment]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/DICTIONARIES.md#alignment @@ -438,4 +438,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props [scroll-view]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/ScrollView/README.md -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Pagination/README.md b/packages/web-react/src/components/Pagination/README.md index 3d613a0831..2d8409e711 100644 --- a/packages/web-react/src/components/Pagination/README.md +++ b/packages/web-react/src/components/Pagination/README.md @@ -180,9 +180,9 @@ and [escape hatches][readme-escape-hatches]. For detailed information see [Pagination][pagination] component. -## Dependencies +## Icons -The Pagination component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [button]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Button/README.md @@ -193,4 +193,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props [ul-element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/ul -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Select/README.md b/packages/web-react/src/components/Select/README.md index 385df2f444..3cdf69339a 100644 --- a/packages/web-react/src/components/Select/README.md +++ b/packages/web-react/src/components/Select/README.md @@ -53,9 +53,9 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Select component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. ## Custom component @@ -102,4 +102,4 @@ For detailed information see [Select][select] component or [Select][select-eleme [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props [select-element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select [select]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web/src/scss/components/Select/README.md -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Spinner/README.md b/packages/web-react/src/components/Spinner/README.md index 788abd449f..149a3bb195 100644 --- a/packages/web-react/src/components/Spinner/README.md +++ b/packages/web-react/src/components/Spinner/README.md @@ -17,13 +17,13 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Spinner component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [dictionary-color]: https://github.com/lmc-eu/spirit-design-system/tree/main/docs/DICTIONARIES.md#color [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Toast/README.md b/packages/web-react/src/components/Toast/README.md index dbabd1b812..523bf1d88a 100644 --- a/packages/web-react/src/components/Toast/README.md +++ b/packages/web-react/src/components/Toast/README.md @@ -423,9 +423,9 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Toast component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [dictionary-alignment]: https://github.com/lmc-eu/spirit-design-system/blob/main/docs/DICTIONARIES.md#alignment @@ -439,4 +439,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-twig/README.md#style-props [scott-o-hara-toast]: https://www.scottohara.me/blog/2019/07/08/a-toast-to-a11y-toasts.html [web-toast]: https://github.com/lmc-eu/spirit-design-system/tree/main/packages/web/src/scss/components/Toast -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/Tooltip/README.md b/packages/web-react/src/components/Tooltip/README.md index 685d16abec..fcdb38a08c 100644 --- a/packages/web-react/src/components/Tooltip/README.md +++ b/packages/web-react/src/components/Tooltip/README.md @@ -79,9 +79,9 @@ On top of the API options, the components accept [additional attributes][readme- If you need more control over the styling of a component, you can use [style props][readme-style-props] and [escape hatches][readme-escape-hatches]. -## Dependencies +## Icons -The Tooltip component uses the `Icon` component internally. To ensure correct rendering, +This component uses the `Icon` component internally. To ensure correct rendering, please refer to the [Icon component documentation][web-react-icon-documentation] for setup instructions. [dictionary-placement]: https://github.com/lmc-eu/spirit-design-system/tree/main/docs/DICTIONARIES.md#placement @@ -95,4 +95,4 @@ please refer to the [Icon component documentation][web-react-icon-documentation] [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props [use-floating-strategy]: https://floating-ui.com/docs/usefloating#strategy -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage diff --git a/packages/web-react/src/components/UNSTABLE_Avatar/README.md b/packages/web-react/src/components/UNSTABLE_Avatar/README.md index e1ec9be926..2965a7b0ce 100644 --- a/packages/web-react/src/components/UNSTABLE_Avatar/README.md +++ b/packages/web-react/src/components/UNSTABLE_Avatar/README.md @@ -114,4 +114,4 @@ and [escape hatches][readme-escape-hatches]. [readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes [readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches [readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props -[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md +[web-react-icon-documentation]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Icon/README.md#-usage