-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add defaults to styleguide config docs/types, finalize readme
- Loading branch information
1 parent
eb81deb
commit 58cc69d
Showing
5 changed files
with
86 additions
and
59 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
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
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 |
|---|---|---|
| @@ -1,34 +1,34 @@ | ||
| /** | ||
| * Configuration for Enhance Styles | ||
| * @typedef {Object} EnhanceStylesConfig | ||
| * @property {boolean} [classes=true] - Emit single purpose classes in addition to CSS custom properties | ||
| * @property {boolean} [reset=true] - Include a CSS reset with Enhance Styles’ output | ||
| * @property {boolean} classes=true - Emit single purpose classes in addition to CSS custom properties | ||
| * @property {boolean} reset=true - Include a CSS reset with Enhance Styles’ output | ||
| * @property {Object} [borders] - Parent object for border properties | ||
| * @property {(string | number)[]} [borders.radii] - Values to use for border radius properties and classes | ||
| * @property {(string | number)[]} [borders.widths] - Values to use for border width properties and classes | ||
| * @property {(string | number)[]} borders.radii=[2,4,8,9999] - Values to use for border radius properties and classes | ||
| * @property {(string | number)[]} borders.widths=[1,2,4] - Values to use for border width properties and classes | ||
| * @property {{[key: string]: string}} [breakpoints] - Named breakpoints enumerating min-width viewport media query values; breakpoint scoped classes will be suffixed with the names of the keys of this object at the viewport width specified | ||
| * @property {Object} [color] - Parent object for color configuration | ||
| * @property {{[key: string]: string}} [color.scales] - Set of named colors with values to use as the median entry for generated color scales; resulting scales will use the key of each entry as their name plus a base 100 suffix from 100 to 900; entries from 400–100 will be progressively lighter; entries from 600–900 will be progressively darker; the -500 entry will duplicate the value provided for each color; colors must be suppled as hexadecimal values | ||
| * @property {{[key: string]: string}} color.scales={gray: '#808080'} - Set of named colors with values to use as the median entry for generated color scales; resulting scales will use the key of each entry as their name plus a base 100 suffix from 100 to 900; entries from 400–100 will be progressively lighter; entries from 600–900 will be progressively darker; the -500 entry will duplicate the value provided for each color; colors must be suppled as hexadecimal values | ||
| * @property {{[key: string]: string}} [color.spots] - Set of named spot colors to use for color custom properties; colors can be supplied in any standardized format | ||
| * @property {{[key: string]: string}} [customProperties] - Set of arbitrary names and string values to use for CSS custom properties | ||
| * @property {{[key: string]: string}} [fonts] - Set of named font stacks to use for font custom properties and classes | ||
| * @property {{[key: string]: string}} fonts={sans='…', serif='…', mono='…'} - Set of named font stacks to use for font custom properties and classes | ||
| * @property {Object} [grid] - Parent object for grid configuration | ||
| * @property {number} [grid.steps] - The number of steps to use when generating [column|row]-[start|end] grid classes | ||
| * @property {number} grid.steps=6 - The number of steps to use when generating [column|row]-[start|end] grid classes | ||
| * @property {Object} [spaceScale] - Parent object for space scale configuration | ||
| * @property {number} [spaceScale.steps=6] - The number of symmetrical intervals to create for the space scale, plus the base size | ||
| * @property {number} [spaceScale.baseMin=16] - The base spacing interval size, in pixels, at the minimum viewport width | ||
| * @property {number} [spaceScale.baseMax=18] - The base spacing interval size, in pixels, at the maximum viewport width | ||
| * @property {number|string} [spaceScale.scaleMin=minor-third] - The ratio, either as a rational number or a named ratio, to use for spacing intervals at the minimum viewport width | ||
| * @property {number|string} [spaceScale.scaleMax=perfect-fourth] - The ratio, either as a rational number or a named ratio, to use for spacing intervals at the maximum viewport width | ||
| * @property {number} [spaceScale.viewportMin=320] - The width, in pixels, of the minimum viewport width the scale should be fluid within | ||
| * @property {number} [spaceScale.viewportMax=1500] - The width, in pixels, of the maximum viewport width the scale should be fluid within | ||
| * @property {number} spaceScale.steps=6 - The number of symmetrical intervals to create for the space scale, plus the base size | ||
| * @property {number} spaceScale.baseMin=16 - The base spacing interval size, in pixels, at the minimum viewport width | ||
| * @property {number} spaceScale.baseMax=18 - The base spacing interval size, in pixels, at the maximum viewport width | ||
| * @property {number|string} spaceScale.scaleMin=minor-third - The ratio, either as a rational number or a named ratio, to use for spacing intervals at the minimum viewport width | ||
| * @property {number|string} spaceScale.scaleMax=perfect-fourth - The ratio, either as a rational number or a named ratio, to use for spacing intervals at the maximum viewport width | ||
| * @property {number} spaceScale.viewportMin=320 - The width, in pixels, of the minimum viewport width the scale should be fluid within | ||
| * @property {number} spaceScale.viewportMax=1500 - The width, in pixels, of the maximum viewport width the scale should be fluid within | ||
| * @property {Object} [typeScale] - Parent object for type scale configuration | ||
| * @property {number} [typeScale.steps=6] -The number of positive intervals, including the base size, for the type scale (two negative intervals added automatically) | ||
| * @property {number} [typeScale.baseMin=16] - The base font size, in pixels, at the minimum viewport width | ||
| * @property {number} [typeScale.baseMax=18] - The base font size, in pixels, at the maximum viewport width | ||
| * @property {number|string} [typeScale.scaleMin=minor-third] - The ratio, either as a rational number or a named ratio, to use for font size intervals at the minimum viewport width | ||
| * @property {number|string} [typeScale.scaleMax=perfect-fourth] - The ratio, either as a rational number or a named ratio, to use for font size intervals at the maximum viewport width | ||
| * @property {number} [typeScale.viewportMin=320] - The width, in pixels, of the minimum viewport width the scale should be fluid within | ||
| * @property {number} [typeScale.viewportMax=1500] - The width, in pixels, of the maximum viewport width the scale should be fluid within | ||
| * @property {number} typeScale.steps=6 - The number of positive intervals, including the base size, for the type scale (two negative intervals added automatically) | ||
| * @property {number} typeScale.baseMin=16 - The base font size, in pixels, at the minimum viewport width | ||
| * @property {number} typeScale.baseMax=18 - The base font size, in pixels, at the maximum viewport width | ||
| * @property {number|string} typeScale.scaleMin=minor-third - The ratio, either as a rational number or a named ratio, to use for font size intervals at the minimum viewport width | ||
| * @property {number|string} typeScale.scaleMax=perfect-fourth - The ratio, either as a rational number or a named ratio, to use for font size intervals at the maximum viewport width | ||
| * @property {number} typeScale.viewportMin=320 - The width, in pixels, of the minimum viewport width the scale should be fluid within | ||
| * @property {number} typeScale.viewportMax=1500 - The width, in pixels, of the maximum viewport width the scale should be fluid within | ||
| */ | ||
|
|