instructure · balzss · Dec 12, 2024 · matyasf · Dec 13, 2024 · matyasf
diff --git a/docs/contributor-docs/v10-upgrade-guide.md b/docs/contributor-docs/v10-upgrade-guide.md
@@ -1,7 +1,7 @@
 ---
 title: Upgrade Guide for Version 10.0
 category: Guides
-order: 7
+order: 98
 ---
 
 # Upgrade Guide for Version 10

diff --git a/docs/guides/layout-spacing.md b/docs/guides/layout-spacing.md
@@ -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.
diff --git a/packages/__examples__/.storybook/stories/SpacingTokens.tsx b/packages/__examples__/.storybook/stories/SpacingTokens.tsx
@@ -0,0 +1,69 @@
+/*
+ * 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 as any} key={token}>{token}</Button>
+      ))}
+    </div>
+  )
+}
+
+export default SpacingTokens
diff --git a/packages/__examples__/.storybook/stories/stories.ts b/packages/__examples__/.storybook/stories/stories.ts
@@ -36,6 +36,7 @@ import { renderPage } from './renderPage'
 import propJSONData from '../../prop-data.json'
 import TooltipPositioning from './TooltipPositioning'
 import FormErrors from './FormErrors'
+import SpacingTokens from './SpacingTokens'
 import SourceCodeEditorExamples from './SourceCodeEditorExamples'
 
 type AdditionalExample = {
@@ -78,6 +79,15 @@ const additionalExamples: AdditionalExample[] = [
       }
     ]
   },
+  {
+    title: 'Spacing tokens',
+    stories: [
+      {
+        storyName: 'Spacing tokens',
+        storyFn: () => SpacingTokens()
+      }
+    ]
+  },
   // TODO: try to fix the editor not rendering fully on chromatic screenshot,
   //  even with delay
   {

diff --git a/packages/ui-color-picker/src/ColorPicker/index.tsx b/packages/ui-color-picker/src/ColorPicker/index.tsx
@@ -399,7 +399,15 @@ class ColorPicker extends Component<ColorPickerProps, ColorPickerState> {
             }}
           >
             <Tooltip renderTip={<span aria-hidden={true}>{tooltip}</span>}>
-              <IconButton withBackground={false} withBorder={false} screenReaderLabel={tooltip} size="small" shape="circle" width="auto" renderIcon={IconInfoLine}/>
+              <IconButton
+                withBackground={false}
+                withBorder={false}
+                screenReaderLabel={tooltip}
+                size="small"
+                shape="circle"
+                width="auto"
+                renderIcon={IconInfoLine}
+              />
             </Tooltip>
           </InstUISettingsProvider>
         </span>
@@ -602,7 +610,8 @@ class ColorPicker extends Component<ColorPickerProps, ColorPickerState> {
   )
 
   render() {
-    const { disabled, isRequired, placeholderText, width, id } = this.props
+    const { disabled, isRequired, placeholderText, width, id, margin } =
+      this.props
 
     return (
       <div
@@ -627,6 +636,7 @@ class ColorPicker extends Component<ColorPickerProps, ColorPickerState> {
           onPaste={(event) => this.handleOnPaste(event)}
           onBlur={() => this.handleOnBlur()}
           messages={this.renderMessages()}
+          margin={margin}
         />
         {!this.isSimple && (
           <div

diff --git a/packages/ui-color-picker/src/ColorPicker/props.ts b/packages/ui-color-picker/src/ColorPicker/props.ts
@@ -26,7 +26,11 @@ import React from 'react'
 import PropTypes from 'prop-types'
 
 import type { FormMessage } from '@instructure/ui-form-field'
-import type { WithStyleProps, ComponentStyle } from '@instructure/emotion'
+import type {
+  WithStyleProps,
+  ComponentStyle,
+  Spacing
+} from '@instructure/emotion'
 import type {
   ColorPickerTheme,
   OtherHTMLAttributes,
@@ -225,6 +229,11 @@ type ColorPickerOwnProps = {
    * If true, alpha slider will be rendered. Defaults to false
    */
   withAlpha?: boolean
+
+  /**
+   * Margin around the component. Accepts a `Spacing` token. See token values and example usage in [this guide](/#layout-spacing).
+   */
+  margin?: Spacing
 }
 
 type ColorPickerState = {
@@ -316,7 +325,8 @@ const propTypes: PropValidators<PropKeys> = {
   id: PropTypes.string,
   value: PropTypes.string,
   width: PropTypes.string,
-  withAlpha: PropTypes.bool
+  withAlpha: PropTypes.bool,
+  margin: PropTypes.string
 }
 
 const allowedProps: AllowedPropKeys = [
@@ -339,7 +349,8 @@ const allowedProps: AllowedPropKeys = [
   'tooltip',
   'value',
   'width',
-  'withAlpha'
+  'withAlpha',
+  'margin'
 ]
 
 export type {

diff --git a/packages/ui-date-input/src/DateInput2/index.tsx b/packages/ui-date-input/src/DateInput2/index.tsx
@@ -153,7 +153,7 @@ const DateInput2 = ({
   dateFormat,
   onRequestValidateDate,
   renderCalendarIcon,
-  // margin, TODO enable this prop
+  margin,
   ...rest
 }: DateInput2Props) => {
   const localeContext = useContext(ApplyLocaleContext)
@@ -278,7 +278,6 @@ const DateInput2 = ({
   return (
     <TextInput
       {...passthroughProps(rest)}
-      // margin={'large'} TODO add this prop to TextInput
       renderLabel={renderLabel}
       onChange={handleInputChange}
       onBlur={handleBlur}
@@ -289,6 +288,7 @@ const DateInput2 = ({
       display={isInline ? 'inline-block' : 'block'}
       messages={inputMessages}
       interaction={interaction}
+      margin={margin}
       renderAfterInput={
         <Popover
           renderTrigger={

diff --git a/packages/ui-date-input/src/DateInput2/props.ts b/packages/ui-date-input/src/DateInput2/props.ts
@@ -33,6 +33,7 @@ import type {
   Renderable,
   PropValidators
 } from '@instructure/shared-types'
+import type { Spacing } from '@instructure/emotion'
 
 type DateInput2OwnProps = {
   /**
@@ -164,12 +165,16 @@ type DateInput2OwnProps = {
     value: string,
     utcDateString: string
   ) => void
-  // margin?: Spacing // TODO enable this prop
 
   /**
    * Custom icon for the icon button opening the picker.
    */
   renderCalendarIcon?: Renderable
+
+  /**
+   * Margin around the component. Accepts a `Spacing` token. See token values and example usage in [this guide](/#layout-spacing).
+   */
+  margin?: Spacing
 }
 
 type PropKeys = keyof DateInput2OwnProps
@@ -201,7 +206,8 @@ const propTypes: PropValidators<PropKeys> = {
   withYearPicker: PropTypes.object,
   dateFormat: PropTypes.oneOfType([PropTypes.string, PropTypes.object]),
   onRequestValidateDate: PropTypes.func,
-  renderCalendarIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func])
+  renderCalendarIcon: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
+  margin: PropTypes.string
 }
 
 export type { DateInput2Props }

diff --git a/packages/ui-form-field/src/FormField/index.tsx b/packages/ui-form-field/src/FormField/index.tsx
@@ -70,6 +70,7 @@ class FormField extends Component<FormFieldProps> {
         as="label"
         htmlFor={this.props.id}
         elementRef={this.handleRef}
+        margin={this.props.margin}
       />
     )
   }

diff --git a/packages/ui-form-field/src/FormField/props.ts b/packages/ui-form-field/src/FormField/props.ts
@@ -32,6 +32,7 @@ import type {
   PropValidators
 } from '@instructure/shared-types'
 import type { FormMessage } from '../FormPropTypes'
+import type { Spacing } from '@instructure/emotion'
 
 type FormFieldOwnProps = {
   label: React.ReactNode
@@ -62,6 +63,11 @@ type FormFieldOwnProps = {
    * provides a reference to the underlying html root element
    */
   elementRef?: (element: Element | null) => void
+
+  /**
+   * Margin around the component. Accepts a `Spacing` token. See token values and example usage in [this guide](/#layout-spacing).
+   */
+  margin?: Spacing
 }
 
 type PropKeys = keyof FormFieldOwnProps
@@ -82,7 +88,8 @@ const propTypes: PropValidators<PropKeys> = {
   vAlign: PropTypes.oneOf(['top', 'middle', 'bottom']),
   width: PropTypes.string,
   inputContainerRef: PropTypes.func,
-  elementRef: PropTypes.func
+  elementRef: PropTypes.func,
+  margin: PropTypes.string
 }
 
 const allowedProps: AllowedPropKeys = [
@@ -97,7 +104,8 @@ const allowedProps: AllowedPropKeys = [
   'vAlign',
   'width',
   'inputContainerRef',
-  'elementRef'
+  'elementRef',
+  'margin'
 ]
 
 export type { FormFieldOwnProps, FormFieldProps }