-
Notifications
You must be signed in to change notification settings - Fork 103
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(many): introduce new spacing tokens; add margin prop for more co…
…mponents
- Loading branch information
Showing
30 changed files
with
548 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| --- | ||
| title: Layout Spacing | ||
| category: Guides | ||
| order: 8 | ||
| --- | ||
|
|
||
| # Layout Spacing | ||
|
|
||
| Our design system provides a set of spacing tokens for consistent layouts and components. Some tokens share values but should be used semantically. For instance, while both `tags` and `buttons` are 0.75rem, `buttons` should be used for spacing between buttons. | ||
|
|
||
| ## Tokens | ||
|
|
||
| | Key | Value | Value in pixels | | ||
| | ----------------- | -------- | --------------- | | ||
| | space0 | 0rem | 0px | | ||
| | space2 | 0.125rem | 2px | | ||
| | space4 | 0.25rem | 4px | | ||
| | space8 | 0.5rem | 8px | | ||
| | space12 | 0.75rem | 12px | | ||
| | space16 | 1rem | 16px | | ||
| | space24 | 1.5rem | 24px | | ||
| | space36 | 2.25rem | 36px | | ||
| | space48 | 3rem | 48px | | ||
| | space60 | 3.75rem | 60px | | ||
| | sections | 2.25rem | 36px | | ||
| | sectionElements | 1.5em | 24px | | ||
| | trayElements | 1.5em | 24px | | ||
| | modalElements | 1.5em | 24px | | ||
| | moduleElements | 1em | 16px | | ||
| | paddingCardLarge | 1.5rem | 24px | | ||
| | paddingCardMedium | 1rem | 16px | | ||
| | paddingCardSmall | 0.75rem | 12px | | ||
| | selects | 1rem | 16px | | ||
| | textAreas | 1rem | 16px | | ||
| | inputFields | 1rem | 16px | | ||
| | checkboxes | 1rem | 16px | | ||
| | radios | 1rem | 16px | | ||
| | toggles | 1rem | 16px | | ||
| | buttons | 0.75rem | 12px | | ||
| | tags | 0.75rem | 12px | | ||
| | statusIndicators | 0.75rem | 12px | | ||
| | dataPoints | 0.75rem | 12px | | ||
|
|
||
| ## Applying Spacing | ||
|
|
||
| There are three main ways to apply spacing in our component library: | ||
|
|
||
| ### 1. Using the `margin` Prop | ||
|
|
||
| Most components in the library support a `margin` prop that works similarly to the CSS margin property. You can specify a single value or fine-tune individual margins (e.g., top, right, bottom, left). | ||
|
|
||
| ```ts | ||
| --- | ||
| type: example | ||
| --- | ||
| <div> | ||
| <Button margin="0 buttons 0 0">Button 1</Button> | ||
| <Button>Button 2</Button> | ||
| </div> | ||
| ``` | ||
|
|
||
| ### 2. Using a Container Component with the `gap` Prop | ||
|
|
||
| For layouts, container components like `Flex` and `Grid` can be used with the gap prop to manage spacing between child elements. | ||
|
|
||
| ```ts | ||
| --- | ||
| type: example | ||
| --- | ||
| <Flex gap="buttons"> | ||
| <Button>Button 1</Button> | ||
| <Button>Button 2</Button> | ||
| </Flex> | ||
| ``` | ||
|
|
||
| ### 3. Importing Values from the Theme | ||
|
|
||
| If you need to directly reference spacing values, you can import them from the theme. This approach is useful for applying spacing in inline styles or custom components. | ||
|
|
||
| ```ts | ||
| --- | ||
| type: code | ||
| --- | ||
| // import the canvas theme | ||
| import canvas from '@instructure/ui-themes' | ||
|
|
||
| // use spacing values | ||
| <div style={{display: 'flex', gap: canvas.spacing.buttons}}> | ||
| <button>Button 1</button> | ||
| <button>Button 2</button> | ||
| </div> | ||
| ``` | ||
|
|
||
| ## Legacy tokens | ||
|
|
||
| For compatibility reasons we still provide the legacy spacing tokens (`xxLarge`, `medium`, etc.) so old layouts don't break when updating InstUI but these tokens shouldn't be used when creating new layouts. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2015 - present Instructure, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import React from 'react' | ||
| import { | ||
| Button, | ||
| ColorPicker, | ||
| TextInput, | ||
| TextArea, | ||
| NumberInput, | ||
| DateInput2 | ||
| } from '@instructure/ui' | ||
|
|
||
| const exampleMargin = 'space36 21px 0 buttons' | ||
|
|
||
| function MarginProp() { | ||
| return ( | ||
| <div> | ||
| <Button margin={exampleMargin}>hello</Button> | ||
| <TextInput margin={exampleMargin} /> | ||
| <TextArea margin={exampleMargin} label="label" /> | ||
| <NumberInput margin={exampleMargin} renderLabel="label" /> | ||
| <ColorPicker | ||
| placeholderText="placeholder" | ||
| label="label" | ||
| margin={exampleMargin} | ||
| /> | ||
| <DateInput2 | ||
| margin={exampleMargin} | ||
| renderLabel="label" | ||
| screenReaderLabels={{ | ||
| calendarIcon: 'asdf', | ||
| prevMonthButton: 'asdf', | ||
| nextMonthButton: 'asdf' | ||
| }} | ||
| /> | ||
| </div> | ||
| ) | ||
| } | ||
|
|
||
| export default MarginProp |
71 changes: 71 additions & 0 deletions
71
packages/__examples__/.storybook/stories/SpacingTokens.tsx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2015 - present Instructure, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| import React from 'react' | ||
| import { Button } from '@instructure/ui' | ||
|
|
||
| function SpacingTokens() { | ||
| const spaceTokens = [ | ||
| 'space0', | ||
| 'space2', | ||
| 'space4', | ||
| 'space8', | ||
| 'space12', | ||
| 'space16', | ||
| 'space24', | ||
| 'space36', | ||
| 'space48', | ||
| 'space60', | ||
| 'sections', | ||
| 'sectionElrements', | ||
| 'trayElrements', | ||
| 'modalElrements', | ||
| 'moduleElrements', | ||
| 'paddingCardLarge', | ||
| 'paddingCardMedium', | ||
| 'paddingCardSmall', | ||
| 'selects', | ||
| 'textareas', | ||
| 'inputFields', | ||
| 'checkboxes', | ||
| 'radios', | ||
| 'toggles', | ||
| 'buttons', | ||
| 'tags', | ||
| 'statusIndicators', | ||
| 'dataPoints' | ||
| ] | ||
|
|
||
| return ( | ||
| <div> | ||
| {spaceTokens.map((token) => ( | ||
| <Button margin={token} key={token}> | ||
| {token} | ||
| </Button> | ||
| ))} | ||
| </div> | ||
| ) | ||
| } | ||
|
|
||
| export default SpacingTokens |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.