@@ -128,30 +128,42 @@ <h4 class="spectrum-Heading spectrum-Heading--sizeXS" id="docs-setters">Setters<
128
128
</ table class="spectrum-Table spectrum-Table--sizeM">
129
129
< h4 class ="spectrum-Heading spectrum-Heading--sizeXS " id ="docs-theme-addcolor-color "> < code > Theme.addColor = color</ code > </ h4 >
130
130
< p > Add a < code > Color</ code > to an existing theme</ p >
131
- < pre > < code class ="lang-js "> < span class ="hljs-keyword "> const</ span > red = new < span class ="hljs-type "> Color</ span > (< span class ="hljs-meta "> {...}</ span > )
131
+ < pre > < code class ="lang-js "> < span class ="hljs-keyword "> let</ span > red = < span class ="hljs-keyword "> new</ span > Color({
132
+ name: < span class ="hljs-string "> 'red'</ span > ,
133
+ colorKeys: [< span class ="hljs-string "> '#FF9A81'</ span > , < span class ="hljs-string "> '#FF0000'</ span > ],
134
+ ratios: [< span class ="hljs-number "> 3</ span > , < span class ="hljs-number "> 4.5</ span > ]
135
+ });
132
136
133
- theme.addColor = red;
137
+ theme.addColor = red;
134
138
</ code > </ pre >
135
139
< h4 class ="spectrum-Heading spectrum-Heading--sizeXS " id ="docs-theme-removecolor-color "> < code > Theme.removeColor = color</ code > </ h4 >
136
140
< p > Remove a < code > Color</ code > from an existing theme. Accepts an object with the < code > Color</ code > 's name and value, or by passing the < code > Color</ code > class itself.</ p >
137
- < pre > < code class ="lang-js "> // < span class ="hljs-type " > Remove </ span > via color name
138
- theme.removeColor = {name: '< span class ="hljs-type "> Red</ span > '};
141
+ < pre > < code class ="lang-js "> < span class ="hljs-comment " > // Remove via color name</ span >
142
+ theme.removeColor = {name: '< span class ="hljs-type "> Red</ span > '};
139
143
140
- // < span class ="hljs-type "> Remove</ span > via < span class ="hljs-type "> Color</ span > class
141
- < span class ="hljs-keyword "> const</ span > red = new < span class ="hljs-type "> Color</ span > (< span class ="hljs-meta "> {...}</ span > )
142
- theme.removeColor = red;
144
+ < span class ="hljs-comment "> // Remove via Color class</ span >
145
+ < span class ="hljs-keyword "> const</ span > red = < span class ="hljs-keyword "> new</ span > Color({
146
+ name: < span class ="hljs-string "> 'red'</ span > ,
147
+ colorKeys: [< span class ="hljs-string "> '#FF9A81'</ span > , < span class ="hljs-string "> '#FF0000'</ span > ],
148
+ ratios: [< span class ="hljs-number "> 3</ span > , < span class ="hljs-number "> 4.5</ span > ]
149
+ });
150
+
151
+ theme.removeColor = red;
143
152
</ code > </ pre >
144
153
< h4 class ="spectrum-Heading spectrum-Heading--sizeXS " id ="docs-theme-updatecolor-name-property "> < code > Theme.updateColor = {name, property}</ code > </ h4 >
145
154
< p > Update a < code > Color</ code > via its setters from the theme. Accepts an object with the name of the color you wish to modify, followed by the property and the new value you wish to modify.</ p >
146
- < pre > < code class ="lang-js "> const red = < span class ="hljs-keyword "> new</ span > Color({...})
147
- < span class ="hljs-comment "> // Change the colors ratios</ span >
148
- theme.updateColor = {< span class ="hljs-string "> name:</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> ratios:</ span > [< span class ="hljs-number "> 3</ span > , < span class ="hljs-number "> 4.5</ span > , < span class ="hljs-number "> 7</ span > ]};
155
+ < pre > < code class ="lang-js "> < span class ="hljs-comment "> // Change the colors ratios</ span >
156
+ theme.updateColor = {< span class ="hljs-string "> color:</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> ratios:</ span > [< span class ="hljs-number "> 3</ span > , < span class ="hljs-number "> 4.5</ span > , < span class ="hljs-number "> 7</ span > ]};
149
157
150
- < span class ="hljs-comment "> // Change the colors colorKeys</ span >
151
- theme.updateColor = {< span class ="hljs-string "> name :</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> colorKeys:</ span > [< span class ="hljs-string "> '#ff0000'</ span > ]};
158
+ < span class ="hljs-comment "> // Change the colors colorKeys</ span >
159
+ theme.updateColor = {< span class ="hljs-string "> color :</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> colorKeys:</ span > [< span class ="hljs-string "> '#ff0000'</ span > ]};
152
160
153
- < span class ="hljs-comment "> // Change the color's name</ span >
154
- theme.updateColor = {< span class ="hljs-string "> name:</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> name:</ span > < span class ="hljs-string "> 'Crimson'</ span > };
161
+ < span class ="hljs-comment "> // Change the color's name</ span >
162
+ theme.updateColor = {< span class ="hljs-string "> color:</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> name:</ span > < span class ="hljs-string "> 'Crimson'</ span > };
163
+ </ code > </ pre >
164
+ < p > Alternatively, it's possible to change all 3 properties in the same call.</ p >
165
+ < pre > < code class ="lang-js "> < span class ="hljs-comment "> // It's also possible to change the color name and colorKeys in the same function</ span >
166
+ theme.updateColor = {< span class ="hljs-string "> color:</ span > < span class ="hljs-string "> 'red'</ span > , < span class ="hljs-string "> ratios:</ span > [< span class ="hljs-number "> 3</ span > , < span class ="hljs-number "> 4.5</ span > , < span class ="hljs-number "> 7</ span > ], < span class ="hljs-string "> colorKeys:</ span > [< span class ="hljs-string "> '#ff0000'</ span > ], < span class ="hljs-string "> name:</ span > < span class ="hljs-string "> 'Crimson'</ span > };
155
167
</ code > </ pre >
156
168
< h4 class ="spectrum-Heading spectrum-Heading--sizeXS " id ="docs-supported-output-formats "> Supported output formats:</ h4 >
157
169
< p > Available output formats conform to the < a href ="https://www.w3.org/TR/css-color-4/ "> W3C CSS Color Module Level 4</ a > spec for the supported options, as listed below:</ p >
0 commit comments