diff --git a/packages/components/src/__illustrations__/Icon/v3/_docs/Icon--usage-guidelines.mdx b/packages/components/src/__illustrations__/Icon/v3/_docs/Icon--usage-guidelines.mdx index e0789b57a44..45a849bfe41 100644 --- a/packages/components/src/__illustrations__/Icon/v3/_docs/Icon--usage-guidelines.mdx +++ b/packages/components/src/__illustrations__/Icon/v3/_docs/Icon--usage-guidelines.mdx @@ -1,12 +1,12 @@ -import { Canvas, Meta, Controls } from "@storybook/blocks" -import { ResourceLinks, KAIOInstallation } from "~storybook/components" +import { Canvas, Meta, Controls, Story } from "@storybook/blocks" +import { ResourceLinks, KAIOInstallation, DosAndDonts, DoOrDont } from "~storybook/components" import * as IconStories from "./Icon.stories" # Icon (v3) -Updated August 28, 2024 +Updated September 3, 2024 - + + +## Guidelines + +Use [default icons](#default-icon-set) (common icons already in use within existing Kaizen components) they will remain available in Figma directly. + +When you need a new icon, use Google's [Material Symbols](https://fonts.google.com/icons) set via the [Figma plugin](https://www.figma.com/community/plugin/1088610476491668236/material-symbols) to add the relevant icons in: +- Outlined +- Weight: 400 +- Grade: Normal (0) +- Fill: On or Off + +They will not need to be added to the Kaizen icon subset in order to be used in designs or to be built. + +### Optical size + +If using icons at a larger size than the default 20px, scale the Optical Size to match the size of the icon. + +Four icons gradually increasing in optical size. + +### Alignment + +Vertically center the icon by shifting down the baseline of symbols to approximately 11.5% of the type size. + + + + + + +## Default icon set + +Whilst you have access to all Material Symbols, the following icons match the default set we have in Figma. + + diff --git a/packages/components/src/__illustrations__/Icon/v3/_docs/Icon.stories.tsx b/packages/components/src/__illustrations__/Icon/v3/_docs/Icon.stories.tsx index c22f7e7a34c..c40266492fd 100644 --- a/packages/components/src/__illustrations__/Icon/v3/_docs/Icon.stories.tsx +++ b/packages/components/src/__illustrations__/Icon/v3/_docs/Icon.stories.tsx @@ -223,3 +223,23 @@ export const DefaultIconSet: Story = { ) }, } + +export const AlignmentDo: Story = { + render: () => ( + Symbol baseline set lower in relation to symbol. + ), +} + +export const AlignmentDont: Story = { + render: () => ( + Both symbol and text set on same baseline. + ), +}