-
+ReadonlyReadonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyImplementation of IAtom.key
Readonly nameReadonlyReadonly requiredIs this a required atom?
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Node.removeListener
ReadonlyThe animation settings for this design system
Readonly bevelThe bevel settings for this design system
Readonly bodyThe body style settings for this design system
Readonly borderThe border settings for this design system
Readonly chartThe chart color settings for this design system
Readonly colorThe color blind settings for this design system
Readonly colorThe color palette for this design system
Readonly colorThe color themes for this design system
Readonly displayThe display and header style settings for this design system
Readonly elevationThe elevation settings for this design system
Readonly focusThe focus state settings for this design system
Readonly fontsThe font settings for this design system
Readonly glowThe glow settings for this design system
Readonly gridThe grid settings for this design system
Readonly hotlinksThe hotlink settings for this design system
Readonly inputThe input background settings for this design system
Readonly keyReadonlyReadonly minimumThe minimum target settings for this design system
Readonly nameReadonlyReadonly smallThe small text style settings for this design system
Readonly statThe stat style settings for this design system
Readonly stateThe state settings for this design system
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe extra large border property
Readonly keyReadonlyThe medium border property
Readonly nameReadonlyThe shadow property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe inverse bevel settings
Readonly keyReadonlyReadonly nameReadonlyReadonly requiredReadonlyThe standard bevel settings
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe blur radius property
The dark shadow opacity property
The horizontal shadow length property
The light glow opacity property
The percentage change property
The spread radius property
Is this a standard bevel?
The vertical shadow length property
The body1 topography styling properties
The body1 bold topography styling properties
The body2 topography styling properties
The body2 bold topography styling properties
The body3 topography styling properties
The body3 bold topography styling properties
Readonly keyReadonlyReadonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe base border radius property
The base border width property
Readonly keyReadonlyReadonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionCall this when there is a more complicated relationship between input properties and output CSS variables.
@@ -114,10 +114,15 @@Optional opts: { Optional or?: booleanThe card border radius property
The card content gap property
Readonly keyReadonlyThe card minimum height property
The card minimum width property
Readonly nameReadonlyThe card padding property
The card shadow property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe center display property
The container display property
The container padding property
The container shadow property
The cutoout thickness property
Readonly keyReadonlyReadonly nameReadonlyThe segment border radius property
The segment shadow property
The space between segments property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe chart lines display property
Readonly keyReadonlyThe line background color style property
The line shadow property
The line width property
Readonly nameReadonlyThe Y labels display property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe container display property
The container padding property
The container shadow property
Readonly keyReadonlyReadonly nameReadonlyThe progress shadow property
The segment radius property
The space between segments property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe container padding property
The container reverse padding property
The cutout thickness range property
Readonly keyReadonlyReadonly nameReadonlyThe segment shadow property
The starting position property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe horizontal padding property
Readonly keyReadonlyThe minimum width property
Readonly nameReadonlyThe radius property
The shadow property
The text property
The visible height property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe CSS code generator
Readonly keyReadonlyReadonly nameReadonlyAll keys associated with all CSS variable groups.
The JSON object.
The JSON object.
The JSON object.
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional listener: Optional eventTypes: Returns ListenerSubscriptionImplementation of IColor.dark
Implementation of IColor.hex
The 0-based index of the color, in the order in which it was added
Readonly keyReadonlyImplementation of IColor.light
Readonly nameReadonlyImplementation of IColor.name
Color specific Shade builder config
+Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe available color blind themes property
Readonly keyReadonlyReadonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyReadonly nameReadonlyReadonly shadesThe generated shades associated with this color and mode
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyThe default color name property
Readonly keyReadonlyImplementation of IColorPalette.key
Readonly nameReadonlyReadonly requiredReadonlyReturn a list of string names for the colors.
Optional filter: Returns Shade[][]Returns all colors in the palette.
Optional filter: Returns Shade[][]The default color (if any).
The default color name.
Optional filter: Returns Shade[][]Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Atom.removeListener
The accent shade property
The button shade property
The darkmode background properties
The gradient1 shade properties
The gradient2 shade properties
The gradient header text shade property
The icon shade property
Readonly keyReadonlyImplementation of IColorTheme.key
The lightmode background properties
Readonly nameReadonlyReadonly primaryThe primary color shade property
Readonly secondaryThe secondary color shade property
Readonly tertiaryThe tertiary color shade property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Node.removeListener
ReadonlyReadonly keyReadonlyImplementation of IColorThemes.key
Readonly nameReadonlyReadonly requiredReadonlyOptional skipInitDefault: The default theme (if any).
The default theme name (if any).
The names of all existing themes.
All theme objects.
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Atom.removeListener
The available colors property
The header text property
Readonly keyReadonlyReadonly nameReadonlyThe padding property
The shadow property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyReadonly codeAll code generators for this design system.
Readonly keyReadonlyImplementation of IDesignSystem.key
Readonly layersAll accessibility layers for this design system
Private metadataDesign system metadata
+Readonly moleculesReadonlyReadonly nameReadonlyReadonly organismsReadonlyWCAG level
+Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Node.removeListener
ReadonlyThe display styles typography styling properties
Readonly headerThe headers styles typography styling properties
The heading display font weight property
Readonly keyReadonlyReadonly nameReadonlyThe percent change in header display sizes property
Readonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe border radius property
Readonly keyReadonlyThe menu focus state property
The menu shadow property
Readonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe base blur radius property
The base color opacity property
The base spread radius property
The blur radius property
The color opacity property
The horizontal shadow length property
Readonly keyReadonlyReadonly nameReadonlyThe percentage change property
Readonly requiredReadonlyThe shadow color property
The spread radius property
The vertical shadow length property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe add focus blur property
The focus color property
Readonly keyReadonlyReadonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe base font size property
The font weights properties
The header line height property
Readonly keyReadonlyReadonly nameReadonlyThe primary font property
Readonly requiredReadonlyThe secondary font property
The small line height property
The small line height property
The standard line height property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe copyright vertical padding property
The footer background property
The footer vertical padding property
Readonly keyReadonlyReadonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe base blur radius property
The glow color property
The base color opacity property
Readonly keyReadonlyReadonly nameReadonlyThe percentage change property
Readonly requiredReadonlyThe base spread radius property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyThe from color shade for this gradient
Readonly toThe to color shade for this gradient
The grid or spacing property
Readonly keyReadonlyReadonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe hero available colors property
The hero body property
Readonly keyReadonlyReadonly nameReadonlyThe hero title property
The hero vertical gap property
The hero vertical spacing property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyReadonly nameReadonlyReadonly requiredReadonlyThe underline hotlinks in light mode property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe general image border radius property
The image shadow property
Readonly keyReadonlyThe list image border radius property
The list image height property
Readonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyImplementation of IInputBackground.key
Readonly nameReadonlyReadonly overlayReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Atom.removeListener
ReadonlyColor blind property
Readonly deviceThe device target property
Readonly dyslexiaDyslexia property
Readonly keyReadonlyReadonly motionMotion sensitivity property
Readonly nameReadonlyReadonly propertiesAll accessbility layer properties
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyThe min height property
The mobile min height property
Readonly nameReadonlyReadonly requiredReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe modal border radius property
The modal color shade property
Readonly keyReadonlyReadonly nameReadonlyThe modal shadow property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyImplementation of IMolecule.key
Readonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Node.removeListener
ReadonlyThe avatars molecule
Readonly chartThe chart bar molecule
Readonly chartThe chart donut molecule
Readonly chartThe chart line molecule
Readonly chartThe chart pie molecule
Readonly chartThe chart progress molecule
Readonly chipsThe chips molecule
Readonly dropdownsThe dropdowns molecule
Readonly imagesThe images molecule
Readonly keyReadonlyImplementation of IMolecules.key
Readonly modalThe modal molecule
Readonly nameReadonlyReadonly popoversThe popovers molecule
Readonly slidersThe sliders molecule
Readonly smallThe small buttons molecule
Readonly spacingThe spacing molecule
Readonly standardThe standard buttons molecule
Readonly standardThe standard cards molecule
Readonly toastsThe toasts molecule
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Node.removeListener
ReadonlyReadonly nameThe name of the node, which is unique relative to it's siblings
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyReadonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyThe data tables organism
Readonly footerThe footer and copyright organism
Readonly heroThe hero organism
Readonly keyReadonlyImplementation of IOrganisms.key
Readonly nameReadonlyReadonly primaryThe primary nav organism
Readonly secondaryThe secondary nav organism
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Inherited from Node.removeListener
The border radius property
Readonly keyReadonlyReadonly nameReadonlyThe shadow property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe fixed property
The horizontal tab padding property
Readonly keyReadonlyReadonly nameReadonlyThe nav text property
The vertical padding property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyImplementation of IProperty.key
Readonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
Inherited from Node.removeListener
ReadonlyReadonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
The horizontal tab padding property
Readonly keyReadonlyReadonly nameReadonlyThe nav text property
The sticky property
The vertical padding property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe shade's B value
The shade's G value
The shade's R value
Private Optional builderFor automatically built shades,
+Optional coreIf this is a core shade such as "Black" or "White", it is set to the core shade name.
+The shade's hex value
The id of the shade
The index of the shade
Optional keyIf this is a shade built from the color palette, it is the unique key to the shade node in the tree
+Private Optional labelThe cached computed label (e.g. 100, 200, etc) for this shade based upon it's lightness value
+Private Optional lightnessThe cached computed lightness value for this shade
+Private Optional luminanceThe cached computed luminance value for this shade
+Private Optional modeThe parent color mode node for this shade if it was generated from the color palette
+The onHex value for this shade
The opacity of the shade
Private Optional perceivedThe cached computed perceived lightness value for this shade
+The shade's RGB array
Private Optional saturationThe cached computed saturation value for this shade
+Static BLACKThe black shade
Static DARK_The dark blue shade
Static DARK_The dark text shade
+Static FULL_The black shade
+Static GRAYThe gray shade
Static HALF_The half-black shade
Static HALF_The half-white shade
Static HALF_The half-white dark mode shade
Static NEAR_The near black shade
Static OFF_The off-black shade
Static OFF_The off-white shade
Static WHITEThe white shade
Static WHITE_The white dark mode shade
A new shade object.
Find a dark mode shade which meets the contrast ratio on these background shades
- -A dark mode shade meeting the contrast ratio requirement, or throws an exception if not found.
-The background shades
-The required contrast ratio
-Find a light mode shade which meets the contrast ratio on this background shade
- -A light mode shade meeting the contrast ratio requirement, or throws an exception if not found.
-The required contrast ratio
-The contrast of this shade to white or black.
The corresponding dark mode shade
The half shade (opacity 0.5) of this shade
The corresponding light mode shade for this shade
Private getBuild 10 shades from this shade, some of which may be lighter and some of which may be darker. -The number of lighter and darker depends on where in the spectrum this shade falls.
- -True if this is for light mode; else false if for dark mode.
-Private getThe lightness of this shade.
The luminance
The mode, or throws exception if node.
The perceived lightness of this shade.
The half shade (opacity 0.25) of this shade
The saturation of this shade.
Find a shade which meets the contrast ratio requirements on this background shade.
- -true for light mode and false for dark mode.
-The contrast ratio requirement
-Return either this shade or the onShade based on contrast requirements to 'shade'.
@@ -721,14 +609,10 @@The shade to compare to this one
Optional multiplier: numberOptional multiplier
-True if it has a mode
True if this is a core shade; false, otherwise.
Optional mode: Returns ShadeStatic coreAll core shades.
Static fromOptional coreShadeName: Static fromRGBStatic fromRGBArrayStatic getThe bar height property
The bar inset shadow property
The handle border radius property
The handle shadow property
Readonly keyReadonlyReadonly nameReadonlyThe visible height property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe button text property
The horizontal padding property
Readonly keyReadonlyReadonly nameReadonlyThe visible height property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe call-to-action topography styling properties
The call-to-action small topography styling properties
The caption topography styling properties
The caption bold topography styling properties
Readonly keyReadonlyThe label1 topography styling properties
The label1 all caps topography styling properties
The label2 all caps topography styling properties
The label2 all caps topography styling properties
The label small topography styling properties
Readonly nameReadonlyThe overline topography styling properties
The overline extra large topography styling properties
The overline large topography styling properties
Readonly requiredReadonlyThe small topography styling properties
The small semi-bold topography styling properties
The subtitle1 topography styling properties
The subtitle2 topography styling properties
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyReadonly nameReadonlyThe paragraph padding property
The section padding property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe button shadow property
The button text property
The height property
The horizontal padding property
Readonly keyReadonlyThe minimum width property
Readonly nameReadonlyThe radius property
The secondary border property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyReadonly nameReadonlyReadonly requiredReadonlyThe stat typography styling properties
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionReadonlyAll state setting properties
Readonly dangerThe danger state setting properties
Design system
+Readonly infoThe info state setting properties
Readonly keyReadonlyReadonly nameReadonlyReadonly readyProperty set to true when everything is ready
Readonly requiredReadonlyColor-specific shade builder config for all state setting shades
+Readonly successThe success state setting properties
Readonly warningThe warning state setting properties
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionOptional opts: Optional sample?: booleanThe list of all design system names.
Static createOptional opts: Returns Promise<ThemeBuilder>The handle border radius property
Readonly keyReadonlyReadonly nameReadonlyThe padding property
The shadow property
Returns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe font family property
The font size property
The font weight property
Readonly keyReadonlyThe character spacing property
The line height property
Readonly nameReadonlyReturns the keys of all properties which are required and not
True if enabled, or false otherwise.
True if initialized, or false otherwise.
Optional eventTypes: Returns ListenerSubscriptionThe unique key of the node
Optional eventTypes:
Hierarchy