@atlaskit/tokens 0.1.1 → 0.4.0

package/dist/es2019/tokens/default/color/background.js

@@ -4,76 +4,93 @@ const color = {
       sunken: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use as a secondary background for the UI'
         }
       },
       default: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use as the primary background for the UI'
         }
       },
       card: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for the background of raised cards, such as Jira cards on a Kanban board.\nCombine with shadow.card.'
         }
       },
       overlay: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use for the background of overlay elements, such as modals, dropdown menus, flags, and inline dialogs (i.e. elements that sit on top of the UI).
+
+Also use for the background of raised cards in a dragged state.
+
+Combine with shadow.overlay.`
         }
       },
       selected: {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for backgrounds of elements in a selected state'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.selected'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.selected'
           }
         }
       },
       blanket: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for the screen overlay that appears with modal dialogs'
         }
       },
       disabled: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for backgrounds of elements in a disabled state'
         }
       },
       boldBrand: {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'A vibrant background for small UI elements like primary buttons and bold in progress lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.boldBrand'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.boldBrand'
           }
         }
       },
@@ -81,19 +98,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for subdued backgrounds of UI elements like information section messages and in progress lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleBrand'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleBrand'
           }
         }
       },
@@ -101,19 +121,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'A vibrant background for small UI elements like danger buttons and bold removed lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.boldDanger'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.boldDanger'
           }
         }
       },
@@ -121,19 +144,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for subdued backgrounds of UI elements like error section messages and removed lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleDanger'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleDanger'
           }
         }
       },
@@ -141,19 +167,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'A vibrant background for small UI elements like warning buttons and bold moved lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.boldWarning'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.boldWarning'
           }
         }
       },
@@ -161,19 +190,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for subdued backgrounds of UI elements like warning section messages and moved lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleWarning'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleWarning'
           }
         }
       },
@@ -181,19 +213,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'A vibrant background for small UI elements like checked toggles and bold success lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.boldSuccess'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.boldSuccess'
           }
         }
       },
@@ -201,19 +236,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for subdued backgrounds of UI elements like success section messages and success lozenges. '
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleSuccess'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleSuccess'
           }
         }
       },
@@ -221,19 +259,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'A vibrant background for small UI elements like onboarding buttons and bold new lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.boldDiscovery'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.boldDiscovery'
           }
         }
       },
@@ -241,19 +282,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for subdued backgrounds of UI elements like discovery section messages and new lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleDiscovery'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleDiscovery'
           }
         }
       },
@@ -261,19 +305,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'A vibrant background for small UI elements like unchecked toggles and bold default lozenges.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state of background.boldNeutral'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state of background.boldNeutral'
           }
         }
       },
@@ -281,13 +328,15 @@ const color = {
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for UIs that don’t have a default background, such as menu items or subtle buttons.'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for UIs that don’t have a default background, such as menu items or subtle buttons.'
           }
         }
       },
@@ -295,19 +344,22 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use as the default background of UI elements like buttons, lozenges, and tags.'
           }
         },
         hover: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleNeutral'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleNeutral'
           }
         }
       },
@@ -315,13 +367,15 @@ const color = {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Hover state for background.subtleBorderedNeutral'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Pressed state for background.subtleBorderedNeutral'
           }
         }
       }

package/dist/es2019/tokens/default/color/border.js

@@ -4,13 +4,15 @@ const color = {
       focus: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for focus rings of elements in a focus state'
         }
       },
       neutral: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use to create borders around UI elements such as text fields, checkboxes, and radio buttons, or to visually group or separate UI elements, such as flat cards or side panel dividers'
         }
       }
     }

package/dist/es2019/tokens/default/color/icon-border.js

@@ -4,31 +4,54 @@ const color = {
       brand: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use rarely for icons or borders representing brand, in-progress, or information, such as the icons in information sections messages.
+
+Also use for blue icons or borders when there is no meaning tied to the color, such as file type icons.`
         }
       },
       danger: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use rarely for icons and borders representing critical information, such the icons in error section messages or the borders on invalid text fields.
+
+Also use for red icons or borders when there is no meaning tied to the color, such as file type icons.`
         }
       },
       warning: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use rarely for icons and borders representing semi-urgent information, such as the icons in warning section messages.
+
+Also use for yellow icons or borders when there is no meaning tied to the color, such as file type icons.
+`
         }
       },
       success: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use rarely for icons and borders representing positive information, such as the icons in success section messages or the borders on validated text fields.
+
+Also use for green icons or borders when there is no meaning tied to the color, such as file type icons.
+`
         }
       },
       discovery: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use rarely for icons and borders representing new information, such as the icons in discovery section mesages or the borders in onboarding spotlights.
+
+Also use for purple icons or borders when there is no meaning tied to the color, such as file type icons.
+`
         }
       }
     }

package/dist/es2019/tokens/default/color/overlay.js

@@ -4,13 +4,15 @@ const color = {
       hover: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use as a background overlay for elements in a hover state when their background color cannot change, such as avatars.'
         }
       },
       pressed: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use as a background overlay for elements in a pressed state when their background color cannot change, such as avatars.'
         }
       }
     }

package/dist/es2019/tokens/default/color/text.js

@@ -4,87 +4,108 @@ const color = {
       selected: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for text, icons, borders, or other visual indicators in selected states'
         }
       },
       highEmphasis: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for primary text, such as body copy, sentence case headers, and buttons'
         }
       },
       mediumEmphasis: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use for secondary text, such navigation, subtle button links, input field labels, and all caps subheadings.
+
+Use for icon-only buttons, or icons paired with text.highEmphasis text
+      `
         }
       },
       lowEmphasis: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: `
+Use for tertiary text, such as meta-data, breadcrumbs, input field placeholder and helper text.
+
+Use for icons that are paired with text.medEmphasis text`
         }
       },
       onBold: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for text and icons when on bold backgrounds'
         }
       },
       onBoldWarning: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for text and icons when on bold warning backgrounds'
         }
       },
       link: {
         resting: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for links in a resting or hover state. Add an underline for hover states'
           }
         },
         pressed: {
           attributes: {
             group: 'paint',
-            description: ''
+            state: 'active',
+            description: 'Use for links in a pressed state'
           }
         }
       },
       brand: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use rarely for text on subtle brand backgrounds, such as in progress lozenges, or on subtle blue accent backgrounds, such as colored tags.'
         }
       },
       warning: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use rarely for text on subtle warning backgrounds, such as in lozenges, or text on subtle warning backgrounds, such as in moved lozenges'
         }
       },
       danger: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use rarely for critical text, such as input field error messaging, or text on subtle danger backgrounds, such as in removed lozenges, or text on subtle red accent backgrounds, such as colored tags.'
         }
       },
       success: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use rarely for positive text, such as input field success messaging, or text on subtle success backgrounds, such as in success lozenges, or text on subtle green accent backgrounds, such as colored tags.'
         }
       },
       discovery: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use rarely for text on subtle discovery backgrounds, such as in new lozenges, or text on subtle purple accent backgrounds, such as colored tags.'
         }
       },
       disabled: {
         attributes: {
           group: 'paint',
-          description: ''
+          state: 'active',
+          description: 'Use for text and icons in disabled states'
         }
       }
     }

package/dist/es2019/tokens/default/shadow/shadow.js

@@ -3,13 +3,23 @@ const shadow = {
     card: {
       attributes: {
         group: 'shadow',
-        description: ''
+        state: 'active',
+        description: `
+Use for the box shadow of raised card elements, such as Jira cards on a Kanban board.
+
+Combine with background.overlay`
       }
     },
     overlay: {
       attributes: {
         group: 'shadow',
-        description: ''
+        state: 'active',
+        description: `
+Use for the box shadow of overlay elements, such as modals, dropdown menus, flags, and inline dialogs (i.e. elements that sit on top of the UI).
+
+Also use for the box shadow of raised cards in a dragged state.
+
+Combine with background.overlay`
       }
     }
   }