@rolemodel/optics 2.3.1 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. package/.github/workflows/deploy-to-ghp.yml +2 -2
  2. package/.github/workflows/deploy-to-npm.yml +9 -5
  3. package/.github/workflows/linting.yml +5 -3
  4. package/.github/workflows/publish-storybook.yml +4 -4
  5. package/.prettierignore +3 -0
  6. package/.yarn/install-state.gz +0 -0
  7. package/CHANGELOG.md +1740 -0
  8. package/README.md +16 -0
  9. package/context7.json +4 -0
  10. package/dist/README.md +16 -0
  11. package/dist/css/addons/fonts/lucide_icons.css +6380 -3081
  12. package/dist/css/addons/fonts/phosphor_icons.css +8 -7
  13. package/dist/css/addons/fonts/tabler_icons.css +2 -1
  14. package/dist/css/components/accordion.css +1 -1
  15. package/dist/css/components/icon.css +30 -0
  16. package/dist/css/components/index.css +26 -26
  17. package/dist/css/components/text_pair.css +5 -1
  18. package/dist/css/core/fonts/index.css +2 -2
  19. package/dist/css/core/tokens/index.css +2 -2
  20. package/dist/css/core/utilities.css +157 -10
  21. package/dist/css/optics+feather_icons.css +600 -12
  22. package/dist/css/optics+feather_icons.min.css +1 -1
  23. package/dist/css/optics+lucide_icons.css +6748 -3088
  24. package/dist/css/optics+lucide_icons.min.css +1 -1
  25. package/dist/css/optics+material_outlined_variable.css +370 -12
  26. package/dist/css/optics+material_outlined_variable.min.css +1 -1
  27. package/dist/css/optics+no_icons.css +370 -12
  28. package/dist/css/optics+no_icons.min.css +1 -1
  29. package/dist/css/optics+phosphor_icons.css +381 -19
  30. package/dist/css/optics+phosphor_icons.min.css +1 -1
  31. package/dist/css/optics+tabler_icons.css +373 -13
  32. package/dist/css/optics+tabler_icons.min.css +1 -1
  33. package/dist/css/optics.css +371 -12
  34. package/dist/css/optics.min.css +1 -1
  35. package/dist/package.json +19 -16
  36. package/package.json +19 -16
package/CHANGELOG.md ADDED
@@ -0,0 +1,1740 @@
1
+ # Changelog
2
+
3
+ All notable changes to this project will be documented in this file.
4
+
5
+ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6
+
7
+ ## [2.5.0] - 2026-09-30
8
+
9
+ ### Component Changes
10
+
11
+ - Add .icon--svg for inline SVG icon sets by @dallasbpeters in https://github.com/RoleModel/optics/pull/359
12
+ - `.icon--svg` is a modifier of `.icon` for icons drawn as inline SVG, such as Hugeicons. Size modifiers work as they do for icon fonts, weight modifiers set the stroke width, and `.icon--low-emphasis` lowers the opacity. Stroke widths can be customized with `--_op-icon-stroke-width-*`.
13
+
14
+ ### Dependencies
15
+
16
+ - Combine Dependabot updates by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/357
17
+ - Nine development dependencies were updated in the lockfile. None of these affect the shipped CSS.
18
+
19
+ ### Documentation Changes
20
+
21
+ - Fix documentation site by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/341
22
+ - Fixed the sidebar examples, the switch syntax example and light-dark compilation on the documentation site, and added browser support to the introduction page
23
+ - Serve AI-Friendly Markdown Docs (llms.txt) from the Docs Site by @zoopmaster in https://github.com/RoleModel/optics/pull/343
24
+ - The documentation is now also served as plain markdown (llms.txt), so AI coding assistants can read component markup, token values and customization patterns
25
+ - Claim Context7 entry to allow admin access by @theojluciano in https://github.com/RoleModel/optics/pull/344
26
+ - Backfill changelog by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/358
27
+ - Added this changelog, with every release since v0.0.1-alpha
28
+
29
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.4.0...v2.5.0
30
+
31
+ ## [2.4.0] - 2026-06-25
32
+
33
+ ### Utility Changes
34
+
35
+ - Add New Utilities by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/340
36
+ - Several more Advanced utilities have been added for easier scaffolding and providing better semantic names around common flex / grid layout scenarios. `op-flank`, `op-grid`, and `op-frame` have been added. See [Advanced Utilities](https://docs.optics.rolemodel.design/?path=/docs/utilities-introduction--docs#advanced-utilities-vs-components) for additional details
37
+
38
+ ### Addon Changes
39
+
40
+ - Update icon libraries by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/338
41
+ - Several of the icon library addons were pointing at older versions. They now point at the latest versions and will include all icons.
42
+
43
+ ### Bug Fixes
44
+
45
+ - Select Only Direct Child Summary When Rotating Accordion Marker by @gavinomelia in https://github.com/RoleModel/optics/pull/330
46
+ - There was a bug where opening an accordion with nesting accordion within it would cause the child accordion markers to also rotate even if those were not open.
47
+
48
+ ### Dependencies
49
+
50
+ - Update dependencies by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/339
51
+ - Storybook (documentation site) has been updated to the latest version along with several of the documentation site dependencies. Note: none of these dependencies affect the shipped CSS.
52
+
53
+ ### Documentation Changes
54
+
55
+ - Update dependencies by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/339
56
+ - Added a favicon for Optics instead of defaulting to the Storybook logo
57
+ - Removed the table of contents background color since it is not needed
58
+ - Fixed issue where the version number on the introduction page was not readable
59
+ - Fixed incorrect documentation around material symbols outlined icons on the icons page
60
+ - Add New Utilities by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/340
61
+ - Fixed a bug where the playground code previews would not allow selecting
62
+
63
+ ### New Contributors
64
+
65
+ - @gavinomelia made their first contribution in https://github.com/RoleModel/optics/pull/330
66
+
67
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.3.1...v2.4.0
68
+
69
+ ## [2.3.1] - 2026-03-05
70
+
71
+ Note: There are no CSS changes in this release. It primarily improves distribution and updates some of the documentation dependencies.
72
+
73
+ ### Distribution Changes
74
+
75
+ - Icon Distribution by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/323
76
+ - Optics can now be imported with one of the supported icon library addons directly instead of having to import it in addition.
77
+ - This resolves the issue of the default material symbols library always being loaded even if you exclusively use a different icon library
78
+ - Add no icons distribution version by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/325
79
+ - If your application uses an icon library that is not directly supported by Optics, you can load Optics with no icon library. This resolves the issue of the default material symbols library always being loaded.
80
+ - Prevent color method changing when minifying css by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/321
81
+ - For better consistency, we want the minified version to still use hsl for colors instead of converting to rgb.
82
+
83
+ For more details on these distribution changes, See the following documentation sections
84
+
85
+ - [Getting Started](https://docs.optics.rolemodel.design/?path=/docs/introduction--docs#getting-started)
86
+ - [Icons](https://docs.optics.rolemodel.design/?path=/docs/components-icon--docs#additional-icon-libraries)
87
+ - [Icon Addons](https://docs.optics.rolemodel.design/?path=/docs/overview-addons--docs#additional-icon-libraries)
88
+
89
+ ### Dependencies
90
+
91
+ - Update dev dependencies by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/322
92
+ - Bump svgo from 4.0.0 to 4.0.1 by @dependabot[bot] in https://github.com/RoleModel/optics/pull/324
93
+
94
+ ### Repository Changes
95
+
96
+ - Fix workflow permissions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/316
97
+ - Split jobs into separate actions with triggers by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/317
98
+
99
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.3.0...v2.3.1
100
+
101
+ ## [2.3.0] - 2026-01-23
102
+
103
+ ### Component Changes
104
+
105
+ - Sidebar and dialog improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/308
106
+ - Documentation around using the modal component with the `<dialog>` element has been modernized and simplified.
107
+ - The navbar and sidebar components borders now will show correctly if used in the footer or right sides!
108
+
109
+ ### Base Token Changes
110
+
111
+ - Sidebar and dialog improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/308
112
+ - A new global token has been added `--op-transition-modal-time: 300ms;`. This can be adjusted to tweak the modal animation timing.
113
+
114
+ ### Layout Changes
115
+
116
+ - Enforce logical properties by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/296
117
+ - Optics has switched to using [Logical Properties](https://developer.mozilla.org/en-US/docs/Glossary/Logical_properties). Normal properties can still be used in your project, but consider using logical properties for better language and direction support.
118
+ - If your project uses stylelint, you can enforce usage with [stylelint-use-logical](https://github.com/csstools/stylelint-use-logical)
119
+ - New layout utilities by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/297
120
+ - Helpful utilities like `op-stack`, `op-cluster`, and `op-split` have been added for quicker scaffolding.
121
+ - New page layout by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/313
122
+ - New classes for page layout have been introduced! These better handle page scrolling and are more flexible than before. The existing classes are still supported, but new projects should use the new layout.
123
+
124
+ ### Bug Fixes
125
+
126
+ - Fix the squish by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/311
127
+ - Fixed a bug with the divider that caused it to disappear when used within flex containers.
128
+
129
+ ### Dependencies
130
+
131
+ - Update documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/298 and https://github.com/RoleModel/optics/pull/301
132
+ - Development dependencies used for generating the documentation site have been updated.
133
+
134
+ ### Documentation Changes
135
+
136
+ - Fix logos in documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/300
137
+ - Fix Icon documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/309
138
+ - Add missed description by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/315
139
+ - Fixes to the documentation to ensure logos show properly, descriptions are accurate and clear.
140
+
141
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.2.0...v2.3.0
142
+
143
+ ## [2.2.0] - 2025-11-10
144
+
145
+ ### New Components
146
+
147
+ - Add Segmented Control by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/292
148
+ - A new component for styled radio group inputs
149
+
150
+ ### Documentation Changes
151
+
152
+ - Fix docs sidebar by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/287
153
+ - The sidebar was not responsive on the documentation side causing issues with content being overlapped.
154
+ - Fix documentation issues by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/289
155
+ - There was an issue with dark mode not showing correctly.
156
+ - Update sidebar organization by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/288
157
+ - Components used to be organized by purpose, but this was found to make it harder to find what users were looking for. The documentation site sidebar now has a flattened list of components.
158
+
159
+ ### Repository Changes
160
+
161
+ - Add more details and instructions to PR template by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/286
162
+ - The Pull Request Template was updated to provide a better checklist of tasks before merging code.
163
+ - Fix documentation issues by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/289
164
+ - The repository did not have a node version set for building the docs
165
+
166
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.1.5...v2.2.0
167
+
168
+ ## [2.1.5] - 2025-07-15
169
+
170
+ ### New Components
171
+
172
+ - [OP-233] Add Content Header Component by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/284
173
+ - A new Content Header component for page or section specific content.
174
+
175
+ ### Documentation Changes
176
+
177
+ - Update logos by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/282
178
+ - Some of the logos in the documentation were using the old RoleModel Logo.
179
+ - Update installation instructions for non-compiled projects by @theoluciano in https://github.com/RoleModel/optics/pull/283
180
+ - Some clarifying documentation was added for projects not using a compilation step.
181
+
182
+ ### New Contributors
183
+
184
+ - @theoluciano made their first contribution in https://github.com/RoleModel/optics/pull/283
185
+
186
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.1.4...v2.1.5
187
+
188
+ ## [2.1.4] - 2025-06-26
189
+
190
+ ### Component Changes
191
+
192
+ - [OP-230] Update card to not use contain paint by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/281
193
+ - `contain: paint` was being used on card to prevent an issue with setting a background color on the card header or footer and not being clipped by the card radius. That caused issues with tooltips or other contents being clipped by the card. This fix introduces a component scoped variable to define the border radius and handle those cases. See the pull request for details.
194
+ - If your application is customizing card and changing the border radius, consider setting the component scoped variable `--_op-card-radius` rather than `border-radius: var(--my-setting)` so that the fix for the header and footer will match the overall radius.
195
+ - If your application was setting `contain: unset` to avoid the overflow problems caused by `contain: paint`, you can remove that as it is no longer needed.
196
+
197
+ ### Dependencies
198
+
199
+ - Bump vite from 5.4.14 to 5.4.19 by @dependabot in https://github.com/RoleModel/optics/pull/280
200
+
201
+ ### Repository Changes
202
+
203
+ - Update README.md by @mikehale in https://github.com/RoleModel/optics/pull/279
204
+
205
+ ### New Contributors
206
+
207
+ - @mikehale made their first contribution in https://github.com/RoleModel/optics/pull/279
208
+
209
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.1.3...v2.1.4
210
+
211
+ ## [2.1.3] - 2025-04-01
212
+
213
+ ### Distribution / Bug Fix Changes
214
+
215
+ - Fix File Import by @Braden-077 in https://github.com/RoleModel/optics/pull/276
216
+ - The distribution folder was not including all the source files causing [Selective Imports](https://docs.optics.rolemodel.design/?path=/docs/overview-selective-imports--docs) to not work.
217
+
218
+ ### New Contributors
219
+
220
+ - @Braden-077 made their first contribution in https://github.com/RoleModel/optics/pull/276
221
+
222
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.1.2...v2.1.3
223
+
224
+ ## [2.1.2] - 2025-03-11
225
+
226
+ ### Distribution Changes
227
+
228
+ - Minify CSS by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/274
229
+ - The distribution folder contained an `optics.min.css` file that was not actually a minified file.
230
+ - In order to clean up the distribution, the main `optics.css` is not a single combined file and `optics.min.css` is a single combined and minified file.
231
+ - The LICENSE, README.md, and package.json file are now included in the distribution folder.
232
+ - No breaking changes or adjustments needed other than bumping your version number.
233
+ - Ensure distribution includes addons by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/275
234
+ - Had to bump from 2.1.1 (really just skipped over as it had to be unpublished) to fix an issue in the distribution folder.
235
+
236
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.1.0...v2.1.2
237
+
238
+ ## [2.1.0] - 2025-02-12
239
+
240
+ ### Breaking Changes
241
+
242
+ - [OP-200] Move fonts to their own files by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/271
243
+ - In order to better allow customization and configuration, the CDN font imports have been moved out of the base tokens and icon files and into their own files under `src/core/fonts`. `src/core/fonts/text_fonts.css` and `src/core/fonts/icon_fonts.css` respectively.
244
+ - If you are using selective imports or are not using the main file import, you may need to add an import for the fonts to ensure your app is still loading them correctly.
245
+
246
+ ```css
247
+ /* Third party Vendors */
248
+ @import 'modern-css-reset/dist/reset';
249
+
250
+ /* Fonts */
251
+ @import 'core/fonts'; /* This is new! */
252
+
253
+ /* Tokens */
254
+ @import 'core/tokens';
255
+
256
+ /* Base styles and utilities */
257
+ @import 'core/base';
258
+ @import 'core/layout';
259
+ @import 'core/utilities';
260
+
261
+ /* Components */
262
+ @import 'components';
263
+ ```
264
+
265
+ - [OP-195] Icon improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/272
266
+ - The default variable icon font loaded for Material Symbols Outlined has been changed to only include the weight axis. This is to reduce load times for apps that don't need it or are using an alternate font. This can be reset back to previous behavior by including `@import '@rolemodel/optics/dist/css/addons/fonts/material_symbols_outlined_variable.css';` just like the new icon packs shown below.
267
+ - The implementation of Icon has been reworked to allow for better customization, overriding, and extensibility. It's API of variables matches other components to allow for this.
268
+ ```css
269
+ /* Weight */
270
+ --_op-icon-weight-light
271
+ --_op-icon-weight-normal
272
+ --_op-icon-weight-semi-bold
273
+ --_op-icon-weight-bold
274
+
275
+ /* Fill */
276
+ --_op-icon-fill-outlined
277
+ --_op-icon-fill-filled
278
+
279
+ /* Emphasis */
280
+ --_op-icon-emphasis-low
281
+ --_op-icon-emphasis-normal
282
+ --_op-icon-emphasis-high
283
+
284
+ /* Size */
285
+ --_op-icon-font-size-small
286
+ --_op-icon-font-size-medium
287
+ --_op-icon-font-size-large
288
+ --_op-icon-font-size-x-large
289
+ --_op-icon-optical-size-small
290
+ --_op-icon-optical-size-medium
291
+ --_op-icon-optical-size-large
292
+ --_op-icon-optical-size-x-large
293
+ ```
294
+ - If you are customizing icons, have a look at the current implementation to see what your refactor should match.
295
+ - Using the Icon classes has slightly changed. Your modifiers work the same, but the base class has been extracted to be `.icon` The Material Symbols specific behavior lives apart from icon generic behavior. This allows for alternative icon libraries.
296
+ - Old usage `<span class='material-symbols-outlined icon--x-large icon--weight-bold'>settings</span>`
297
+ - New usage `<span class='material-symbols-outlined icon icon--x-large icon--weight-bold'>settings</span>`
298
+ - If you are using an icon helper, you will need to update it to include the `.icon` class. If you are in a Rails context, The icon generator in [RoleModel Rails](https://github.com/RoleModel/rolemodel_rails/blob/master/lib/generators/rolemodel/optics/icons/templates/app/helpers/icon_helper.rb)) has been updated to support all the new fonts
299
+
300
+ ### Component Changes
301
+
302
+ - [OP-195] Icon improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/272
303
+ - The Icon API has been reworked to better match other components. This means it is easier to override and customize aspects of the icon like the sizes or other modifiers and what values they have.
304
+ - Icons now support the `.icon--small` modifier for using smaller icons
305
+
306
+ - [OP-28] Custom Icon Support by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/273
307
+ - Optics now supports four new Icon Libraries!
308
+ - [Phosphor](https://phosphoricons.com/)
309
+ - [Tabler](https://tabler.io/icons)
310
+ - [Feather](https://feathericons.com/)
311
+ - [Lucide](https://lucide.dev/icons/)
312
+ - Simply add an import for the specific library `@import '@rolemodel/optics/dist/css/addons/fonts/phosphor_icons';`
313
+ - Usage will look like `<i class='ph ph-smiley icon--x-large icon--weight-thin'></i>` but will vary for each Library
314
+ - See the documentation for specifics implementation details and which icon modifiers are supported in each library.
315
+ - If your app is built on Rails and you are using [RoleModel Rails](https://github.com/RoleModel/rolemodel_rails), the [Icon Generator](https://github.com/RoleModel/rolemodel_rails/tree/master/lib/generators/rolemodel/optics/icons) now prompts you for which icon library you are using and generates the correct helper methods for you.
316
+
317
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.0.1...v2.1.0
318
+
319
+ ## [1.13.1] - 2025-02-11
320
+
321
+ ### Breaking Changes
322
+
323
+ - [CCC-47] Tokens by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/263
324
+ - The majority of files have been converted from `scss` to `css`. This shouldn't be a major change or cause issues with how you import Optics. A potential case is if you are selectively importing specific files, you may need to change the extension. This includes Addons, Components, and Tokens.
325
+ - Tokens are no longer organized into mixins that then get included into the `:root` element. They just live directly in `:root`. If you were doing any scale overriding and mixing the scale into a sub component, you may need to review that and adjust it or manually copy the tokens into where you need them.
326
+ - The dark mode scale file has been removed. This is because those tokens now live inside the scale color tokens file side by side with their light mode counterparts. We are utilizing the newer [light-mode()](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/light-dark)
327
+
328
+ ### Token Changes
329
+
330
+ - Color Scale Tokens now use the `light-dark()` function by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/263
331
+ - See https://developer.mozilla.org/en-US/docs/Web/CSS/color_value/light-dark
332
+ - This allows for easier theming. Seeing the light and dark values in one place, and being able to set theme mode at any given scope level.
333
+ - One note to be aware of is that if you are using your variables as the `fill` option on an SVG, you may run into issues with the `light-dark()` function and the SVG not knowing how to parse it. In this case, you might consider separating out the light and dark versions of the variable and using the values directly.
334
+
335
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.12.0...v1.13.0
336
+
337
+ ## [2.0.1] - 2025-02-10
338
+
339
+ ### Base Token Changes
340
+
341
+ - [OP-198] Accordion Add Animation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/267
342
+ - A new token `--op-transition-accordion-content` has been added. This can be used to adjust the timing of the new accordion opening and closing animation.
343
+
344
+ ### Component Changes
345
+
346
+ - [OP-198] Accordion Add Animation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/267
347
+ - Accordions now animate when opening and closing by default!
348
+ - This can be disabled by using a new component modifier `.accordion.accordion--disable-animation`
349
+ - Note: This animation does not currently work on Safari or Firefox, however it falls back gracefully to the existing behavior before this change of opening and closing with no animation. Support will be added in the future.
350
+
351
+ ### Dependencies
352
+
353
+ - [OP-199] Documentation Improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/268
354
+ - Storybook (Documentation site) has been updated to the latest version `8.5.3`
355
+
356
+ ### Documentation Changes
357
+
358
+ - Spell modules correctly by @jdmcleod in https://github.com/RoleModel/optics/pull/269
359
+ - Minor typo fix
360
+ - [OP-198] Accordion Add Animation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/267
361
+ - Some instructions were added to the Accordion documentation for how to utilize the exclusive open feature of `<detail>` elements. See more https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#name
362
+
363
+ ### New Contributors
364
+
365
+ - @jdmcleod made their first contribution in https://github.com/RoleModel/optics/pull/269
366
+
367
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v2.0.0...v2.0.1
368
+
369
+ ## [2.0.0] - 2025-01-31
370
+
371
+ ### Breaking Changes
372
+
373
+ - Optics is no longer using SCSS by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/266
374
+ - All references to SCSS or SASS have been removed.
375
+ - The import paths for files should change from `@rolemodel/optics/dist/scss/optics` to `@rolemodel/optics/dist/css/optics`
376
+ - There is now a `@rolemodel/optics/dist/css/optics.min.css` which is one file with all of Optics in it, rather than individual files.
377
+ - Any selective imports will need to point to the `css` dist folder instead of `scss`
378
+
379
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.13.0...v2.0.0
380
+
381
+ ## [1.12.0] - 2025-01-31
382
+
383
+ ### Breaking Changes
384
+
385
+ - [OP-193] Refactor Sidebar by @zoopmaster in https://github.com/RoleModel/optics/pull/264
386
+ - Sidebar has been converted to be pure BEM style. This means that variants like `.sidebar-primary` is now `.sidebar--primary`.
387
+ - If your app is using this component, you will need to use the base `.sidebar` class in addition to the modifier for the particular variant.
388
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%sidebar-global` with the base selector `.sidebar` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
389
+
390
+ ```css
391
+ /* Old */
392
+ %sidebar-global {
393
+ color: red;
394
+ }
395
+
396
+ .sidebar-purple {
397
+ background-color: purple;
398
+ }
399
+
400
+ /* Usage: .sidebar-purple */
401
+ ```
402
+
403
+ ```css
404
+ /* New */
405
+ .sidebar {
406
+ color: red;
407
+
408
+ &.sidebar--purple {
409
+ background-color: purple;
410
+ }
411
+ }
412
+
413
+ /* Usage: .sidebar.sidebar--purple */
414
+ ```
415
+
416
+ - **`.sidebar--responsive` has been removed** The main reason is that it is not being used very much and introduces a lot of complexity to the sidebar. Most applications end up hiding the sidebar on mobile and using a drawer pattern or alternative approach. This is best done with some simple JS to change out the sidebar style (`.sidebar--drawer`, `.sidebar--compact`, `.sidebar--rail`). See https://docs.optics.rolemodel.design/?path=/docs/navigation-components-sidebar--docs for details on a javascript solution to add a responsive sidebar back.
417
+
418
+ ### Component Changes
419
+
420
+ - Refactor Sidebar to not use placeholder selectors by @zoopmaster in https://github.com/RoleModel/optics/pull/264
421
+
422
+ ### Documentation Changes
423
+
424
+ - Add details to sidebar documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/265
425
+
426
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.11.0...v1.12.0
427
+
428
+ ## [1.11.0] - 2025-01-30
429
+
430
+ ### Breaking Changes
431
+
432
+ - OP-179 Refactor Form by @dominicmacaulay in https://github.com/RoleModel/optics/pull/262
433
+ - Form has been converted to be pure BEM style. `.form-control` did not have variants since it mainly changed look based on input type. You may want to review usage, but because of this, you shouldn't need to change much.
434
+ - If you are customizing the styles, you will need to replace the following placeholder selectors
435
+ - `%form-control-global` with. `.form-control`
436
+ - `%form-control-input-global` with `.form-control:not([type='radio'], [type='checkbox'])`
437
+ - `%form-control-inline-global` with `.form-control:is([type='radio'], [type='checkbox'])`
438
+ - `%dropdown-arrow` with `[.form](select.form-control:not([multiple], [type='radio'], [type='checkbox']))`
439
+ - You will no longer need to extend the placeholder selector since these styles are based on the input type.
440
+
441
+ ```css
442
+ /* Old */
443
+ %form-control-global {
444
+ color: red;
445
+ }
446
+
447
+ .form-control-purple {
448
+ background-color: purple;
449
+ }
450
+
451
+ /* Usage: input.form-control-purple */
452
+ ```
453
+
454
+ ```css
455
+ /* New */
456
+ .form-control {
457
+ color: red;
458
+
459
+ &.form-control--purple {
460
+ background-color: purple;
461
+ }
462
+ }
463
+
464
+ /* Usage: input.form-control.form-control--purple */
465
+ ```
466
+
467
+ NOTE: There is a know issue with `.form-group` where the padding is incorrectly set to `padding-block: var(--op-space-small) 0;` which effectively only sets `padding-block-start` instead of just `padding-block`. This was resolved in `v2.0.0` In the mean time, you can add a temporary override to your code
468
+
469
+ in `your-form.css`
470
+
471
+ ```css
472
+ .form-group {
473
+ padding-block: var(--op-space-small); /* TODO: This can be removed once using Optics v2.0.0 */
474
+ }
475
+ ```
476
+
477
+ ### Component Changes
478
+
479
+ - Refactor Form component to no longer use placeholder selectors by @dominicmacaulay in https://github.com/RoleModel/optics/pull/262
480
+
481
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.10.0...v1.11.0
482
+
483
+ ## [1.10.0] - 2025-01-30
484
+
485
+ ### Breaking Changes
486
+
487
+ - [OP-172] Refactor button and button-group by @zoopmaster in https://github.com/RoleModel/optics/pull/261
488
+ - **Note:** These comments apply to both Button and Button Group, but we use Button as the example.
489
+ - Button has been converted to be pure BEM style. This means that variants like `.btn-primary` is now `.btn--primary`.
490
+ - If your app is using this component, you will need to use the base `.btn` class in addition to the modifier for the particular variant.
491
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%btn-global` with the base selector `.btn` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
492
+
493
+ ```css
494
+ /* Old */
495
+ %btn-global {
496
+ color: red;
497
+ }
498
+
499
+ .btn-purple {
500
+ background-color: purple;
501
+ }
502
+
503
+ /* Usage: .btn-purple */
504
+ ```
505
+
506
+ ```css
507
+ /* New */
508
+ .btn {
509
+ color: red;
510
+
511
+ &.btn--purple {
512
+ background-color: purple;
513
+ }
514
+ }
515
+
516
+ /* Usage: .btn.btn--purple */
517
+ ```
518
+
519
+ ### Components Changes
520
+
521
+ - Refactor button and button-group to not use placeholder selectors by @zoopmaster in https://github.com/RoleModel/optics/pull/261
522
+
523
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.9.0...v1.10.0
524
+
525
+ ## [1.9.0] - 2025-01-30
526
+
527
+ ### Breaking Changes
528
+
529
+ - OP-189 Refactor Table by @dominicmacaulay in https://github.com/RoleModel/optics/pull/258
530
+ - Table has been converted to be pure BEM style. This means that `.table-primary` is now `.table--primary`.
531
+ - If your app is using this component, you will need to use the base `.table` class in addition to the modifier for the particular variant.
532
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%table-global with the base selector `.table` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
533
+
534
+ ```css
535
+ /* Old */
536
+ %table-global {
537
+ color: red;
538
+ }
539
+
540
+ .table-purple {
541
+ background-color: purple;
542
+ }
543
+
544
+ /* Usage: .table-purple */
545
+ ```
546
+
547
+ ```css
548
+ /* New */
549
+ .table {
550
+ color: red;
551
+
552
+ &.table--purple {
553
+ background-color: purple;
554
+ }
555
+ }
556
+
557
+ /* Usage: .table.table--purple */
558
+ ```
559
+
560
+ ### Component Changes
561
+
562
+ - Refactor Table to not use a placeholder selector by @dominicmacaulay in https://github.com/RoleModel/optics/pull/258
563
+
564
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.8.0...v1.9.0
565
+
566
+ ## [1.8.0] - 2025-01-30
567
+
568
+ ### Breaking Changes
569
+
570
+ - [OP-182] Refactor Navbar by @zoopmaster in https://github.com/RoleModel/optics/pull/259
571
+ - Navbar has been converted to be pure BEM style. This means that `.navbar-primary` is now `.navbar--primary`.
572
+ - If your app is using this component, you will need to use the base `.navbar` class in addition to the modifier for the particular variant.
573
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%navbar-global with the base selector `.navbar` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
574
+
575
+ ```css
576
+ /* Old */
577
+ %navbar-global {
578
+ color: red;
579
+ }
580
+
581
+ .navbar-purple {
582
+ background-color: purple;
583
+ }
584
+
585
+ /* Usage: .navbar-purple */
586
+ ```
587
+
588
+ ```css
589
+ /* New */
590
+ .navbar {
591
+ color: red;
592
+
593
+ &.navbar--purple {
594
+ background-color: purple;
595
+ }
596
+ }
597
+
598
+ /* Usage: .navbar.navbar--purple */
599
+ ```
600
+
601
+ ### Component Changes
602
+
603
+ - Refactor Navbar to not use a placeholder selector by @zoopmaster in https://github.com/RoleModel/optics/pull/259
604
+
605
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.7.0...v1.8.0
606
+
607
+ ## [1.7.0] - 2025-01-30
608
+
609
+ ### Breaking Changes
610
+
611
+ - [OP-176] Refactor Card by @zoopmaster in https://github.com/RoleModel/optics/pull/260
612
+ - Card has been converted to be pure BEM style. This means that `.card-padded` is now `.card--padded`.
613
+ - If your app is using this component, you will need to use the base `.card` class in addition to the modifier for the particular variant.
614
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%card-global with the base selector `.card` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
615
+
616
+ ```css
617
+ /* Old */
618
+ %card-global {
619
+ color: red;
620
+ }
621
+
622
+ .card-purple {
623
+ background-color: purple;
624
+ }
625
+
626
+ /* Usage: .card-purple */
627
+ ```
628
+
629
+ ```css
630
+ /* New */
631
+ .card {
632
+ color: red;
633
+
634
+ &.card--purple {
635
+ background-color: purple;
636
+ }
637
+ }
638
+
639
+ /* Usage: .card.card--purple */
640
+ ```
641
+
642
+ ### Component Changes
643
+
644
+ - Refactor Card to not use a placeholder selector by @zoopmaster in https://github.com/RoleModel/optics/pull/260
645
+
646
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.6.0...v1.7.0
647
+
648
+ ## [1.6.0] - 2025-01-30
649
+
650
+ ### Breaking Changes
651
+
652
+ - OP-181 Refactor Modal and ConfirmDialog by @dominicmacaulay in https://github.com/RoleModel/optics/pull/257
653
+ - Note: These comments apply to both Modal and Confirm Dialog, but we use Modal as the example.
654
+ - Modal has been converted to be pure BEM style. This component did not have more than one variant, but if you have created one, it will need to be converted to a modifier.
655
+ - If your app is using this component, you will need to use the base `.modal` class in addition to the modifier for the particular variant.
656
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%modal-global` and `%modal-wrapper-global` with the base selector `.modal` and `.modal-wrapper` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
657
+
658
+ ```css
659
+ /* Old */
660
+ %modal-global {
661
+ color: red;
662
+ }
663
+
664
+ .modal-purple {
665
+ background-color: purple;
666
+ }
667
+
668
+ /* Usage: .modal-purple */
669
+ ```
670
+
671
+ ```css
672
+ /* New */
673
+ .modal {
674
+ color: red;
675
+
676
+ &.modal--purple {
677
+ background-color: purple;
678
+ }
679
+ }
680
+
681
+ /* Usage: .modal.modal--purple */
682
+ ```
683
+
684
+ ### Component Changes
685
+
686
+ - Modal and ConfirmDialog are refactored to no longer use placeholder selectors by @dominicmacaulay in https://github.com/RoleModel/optics/pull/257
687
+
688
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.5.0...v1.6.0
689
+
690
+ ## [1.5.0] - 2025-01-30
691
+
692
+ ### Breaking Changes
693
+
694
+ - OP-174 Refactor Badge and Tag by @dominicmacaulay in https://github.com/RoleModel/optics/pull/256
695
+ - Note: These comments apply to both Badge and Tag, but we use badge as the example.
696
+ - Badge has been converted to be pure BEM style. This means that `.badge-primary` is now `.badge.badge--primary`.
697
+ - If your app is using this component, you will need to use the base `.badge` class in addition to the modifier for the particular variant.
698
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector %badge-global with the base selector `.badge` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class.
699
+
700
+ ```css
701
+ /* Old */
702
+ %badge-global {
703
+ color: red;
704
+ }
705
+
706
+ .badge-purple {
707
+ background-color: purple;
708
+ }
709
+
710
+ /* Usage: .badge-purple */
711
+ ```
712
+
713
+ ```css
714
+ /* New */
715
+ .badge {
716
+ color: red;
717
+
718
+ &.badge--purple {
719
+ background-color: purple;
720
+ }
721
+ }
722
+
723
+ /* Usage: .badge.badge--purple */
724
+ ```
725
+
726
+ ### Component Changes
727
+
728
+ - Tag and Badge have been updated to not use placeholder selectors by @dominicmacaulay in https://github.com/RoleModel/optics/pull/256
729
+
730
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.4.0...v1.5.0
731
+
732
+ ## [1.4.0] - 2025-01-30
733
+
734
+ ### Breaking Changes
735
+
736
+ - [OP-170] Refactor Simple Components by @zoopmaster in https://github.com/RoleModel/optics/pull/255
737
+ - **Note:** These comments apply to all of the following components, but we use Accordion as the example. `accordion`, `avatar`, `breadcrumbs`, `pagination`, `side-panel`, `spinner`, `switch`, `tab`, `text-pair`, `divider`, and `tooltip`
738
+ - Accordion has been converted to be pure BEM style. This component did not have more than one variant, but if you had created one, it will need to be converted to a modifier.
739
+ - If your app is using this component, you will continue to use the `.accordion` class.
740
+ - If you are customizing the styles, you will need to replace the placeholder selector `%accordion-global` with the base selector `.accordion` and any variants you have customized or added will need to become modifiers. You will no longer need to extend the placeholder selector since your new class is now a modifier and meant to be used with the base class
741
+
742
+ ```css
743
+ /* Old */
744
+ %accordion-global {
745
+ color: red;
746
+ }
747
+
748
+ .accordion-purple {
749
+ background-color: purple;
750
+ }
751
+
752
+ /* Usage: .accordion-purple */
753
+ ```
754
+
755
+ ```css
756
+ /* New */
757
+ .accordion {
758
+ color: red;
759
+
760
+ &.accordion--purple {
761
+ background-color: purple;
762
+ }
763
+ }
764
+
765
+ /* Usage: .accordion.accordion--purple */
766
+ ```
767
+
768
+ ### Component Changes
769
+
770
+ - [OP-170] Refactor Simple Components by @zoopmaster in https://github.com/RoleModel/optics/pull/255
771
+
772
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.3.0...v1.4.0
773
+
774
+ ## [1.3.0] - 2025-01-29
775
+
776
+ ### Breaking Changes
777
+
778
+ - There is an issue with how the SASS package compiles CSS. If the console outputs build failure messages related to `.alert--icon {`, ensure the `"sass"` package in `package.json` is set to at least `1.77`.
779
+ - OP-173 Refactor Alert by @dominicmacaulay in https://github.com/RoleModel/optics/pull/254
780
+ - Alert variants have been converted to be pure BEM style. This means that `.alert-warning` is now `.alert.alert--warning`.
781
+ - If your app is using this component you will need to use the base `.alert` class in addition to the modifier for the particular variant you want.
782
+ - Additionally, if you are customizing the styles, you will need to replace the placeholder selector `%alert-global` with the base selector `.alert` and any variants you have customized or added will need to become modifiers. `.alert--danger` instead of `.alert-danger`. You will no longer need to extend the placeholder selector since your class is now a modifier and meant to be used with the base class.
783
+
784
+ ```css
785
+ /* Old */
786
+ %alert-global {
787
+ gap: var(--op-space-large);
788
+ }
789
+
790
+ .alert-purple {
791
+ @extend %alert-global;
792
+
793
+ background-color: purple;
794
+ }
795
+
796
+ /* Usage: .alert-purple */
797
+ ```
798
+
799
+ ```css
800
+ /* New */
801
+ .alert {
802
+ gap: var(--op-space-large);
803
+ }
804
+
805
+ .alert.alert--purple {
806
+ background-color: purple;
807
+ }
808
+
809
+ /* Usage: .alert.alert--purple */
810
+ ```
811
+
812
+ ### Components
813
+
814
+ - OP-173 Refactor Alert by @dominicmacaulay in https://github.com/RoleModel/optics/pull/254
815
+
816
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.2.0...v1.3.0
817
+
818
+ ## [1.2.0] - 2025-01-29
819
+
820
+ ### Breaking Changes
821
+
822
+ - Remove the `.flexible-layout-area` and `.layout-row` utility classes by @dominicmacaulay in https://github.com/RoleModel/optics/pull/253
823
+ - These were inherited from older patterns at RoleModel, however they were never documented or really intended to be used. Since that is the case, we are removing them to simplify the code.
824
+ - If you were using them, you may need to change your implementations or copy the code back into your project.
825
+
826
+ - CCC-44 Breakpoint Variables by @dominicmacaulay in https://github.com/RoleModel/optics/pull/252
827
+ - In an effort to reduce dependencies on SCSS features, we want to remove the $breakpoint-... SCSS variables. Media queries cannot use CSS variables and the spec for environment variables doesn't seem like it is moving anytime soon. https://drafts.csswg.org/css-env-1/
828
+ - A larger goal is to move away from needing SCSS entirely since pure CSS supports a large amount of the features we depended on from SCSS.
829
+ - If your project was using these SCSS variables, you will need to copy the values and follow the [documenting guide](https://docs.optics.rolemodel.design/?path=/docs/tokens-breakpoint--docs).
830
+ - `$breakpoint-x-small` should become: `512px` with a comment of `/* --op-breakpoint-x-small */`
831
+ - `$breakpoint-small` should become: `768px` with a comment of `/* --op-breakpoint-small */`
832
+ - `$breakpoint-medium` should become: `1024px` with a comment of `/* --op-breakpoint-medium */`
833
+ - `$breakpoint-large` should become: `1280px` with a comment of `/* --op-breakpoint-large */`
834
+ - `$breakpoint-x-large` should become: `1440px` with a comment of `/* --op-breakpoint-x-large */`
835
+
836
+ ### Utilities Changes
837
+
838
+ - Remove the `.flexible-layout-area` and `.layout-row` utility classes by @dominicmacaulay in https://github.com/RoleModel/optics/pull/253
839
+ - These features were not documented or intended to be used.
840
+
841
+ ### Documentation Changes
842
+
843
+ - Update the RoleModel logo used in the documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/249
844
+ - See https://rolemodelsoftware.com/blog/announcing-rolemodels-new-brand
845
+
846
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.1.0...v1.2.0
847
+
848
+ ## [1.1.0] - 2024-12-16
849
+
850
+ ### Breaking Changes
851
+
852
+ - `--op-z-index-drawer` rename by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/234
853
+ - The name of drawer was inaccurate since the token is meant to be used for the sidebar. This updates it to be clearer.
854
+ - This should be a simple find-and-replace situation to change from `--op-z-index-drawer` to `--op-z-index-sidebar`
855
+
856
+ ### Base Token Changes
857
+
858
+ - Update the font import to use newer syntax by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/235
859
+ - `--op-font-family-alt` was added to accompany the existing font options as an alternative option.
860
+ - `--op-z-index-drawer` rename by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/234
861
+ - `--op-z-index-drawer` was renamed to `--op-z-index-sidebar` (as noted in the breaking changes section)
862
+
863
+ ### Component Changes
864
+
865
+ - Improve icon font initial page load state by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/240
866
+ - Added the `display=block` option to the Material Icons font import to prevent the underlying text from showing while loading.
867
+ - Use correct cursor for color input by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/233
868
+ - The color input did not have the correct cursor when hovering. This updated it to use the pointer cursor
869
+
870
+ ### Documentation Changes
871
+
872
+ - Fix tab link in docs by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/228
873
+ - Clicking on one of the example tab links caused the documentation site to throw an error
874
+ - cleanup documentation on Addons.mdx ScaleOverriding.mdx and Tokens.mdx by @yawnybear in https://github.com/RoleModel/optics/pull/232
875
+ - Minor grammatical fixes
876
+ - Fix href Link on Avatar Component by @dominicmacaulay in https://github.com/RoleModel/optics/pull/238
877
+ - Clicking on the example avatar caused the documentation site to throw an error
878
+ - Optics documentation fixes (GH-239) by @yawnybear in https://github.com/RoleModel/optics/pull/239
879
+ - Grammatical fixes and rewording to add clarity.
880
+ - Variable Font Instructions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/247
881
+ - Improving the font family documentation and adding instructions on how to better utilize variable fonts.
882
+
883
+ ### Dependencies (Documentation Site)
884
+
885
+ - Storybook upgrade by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/230
886
+ - Bump ws from 8.17.0 to 8.17.1 by @dependabot in https://github.com/RoleModel/optics/pull/231
887
+ - Bump cross-spawn from 7.0.3 to 7.0.6 by @dependabot in https://github.com/RoleModel/optics/pull/244
888
+ - Bump vite from 5.2.11 to 5.2.14 by @dependabot in https://github.com/RoleModel/optics/pull/241
889
+ - Bump nanoid from 3.3.7 to 3.3.8 by @dependabot in https://github.com/RoleModel/optics/pull/242
890
+ - Bump express from 4.19.2 to 4.21.2 by @dependabot in https://github.com/RoleModel/optics/pull/245
891
+ - Bump micromatch from 4.0.6 to 4.0.8 by @dependabot in https://github.com/RoleModel/optics/pull/246
892
+
893
+ ### New Contributors
894
+
895
+ - @yawnybear made their first contribution in https://github.com/RoleModel/optics/pull/232
896
+ - @dominicmacaulay made their first contribution in https://github.com/RoleModel/optics/pull/238
897
+
898
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v1.0.0...v1.1.0
899
+
900
+ ## [1.0.0] - 2024-02-29
901
+
902
+ Check out https://optics.rolemodel.design to learn how RoleModel teams collaborate using Optics to crafting excellent design solutions.
903
+
904
+ ### Breaking Changes
905
+
906
+ - `--op-border-color` rename by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/212
907
+ - The border color token did not match the token naming pattern for other colors. This updates it to be consistent
908
+ - This should be a simple find-and-replace situation to change from `--op-border-color` to `--op-color-border`
909
+ - Compound Selector with `::file-selector-button` bug by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/221
910
+ - Due to how buttons were implemented, the styling for the input of type `file` would cause issues when trying to style all buttons.
911
+ - I suspect most projects are not styling this specific element, but if it is, it will need to be updated. Check the Pull Request for details
912
+
913
+ ### Base Token Changes
914
+
915
+ - `--op-border-color` rename by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/212
916
+ - The border color token did not match the token naming pattern for other colors. This updates it to be consistent
917
+ - This should be a simple find-and-replace situation to change from `--op-border-color` to `--op-color-border`
918
+
919
+ ### Component Changes
920
+
921
+ - Rename `btn-delete` to `btn-destructive` by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/222
922
+ - There may be a case where your application wishes to use a red "danger" button to indicate a destructive action. That may not always be Delete. The delete name was too specific and wasn't consistent with other buttons names.
923
+ - This is a backwards compatible change. The `btn-delete` class still works so no code change is necessary. If your application customizes the delete button, you may want to update any selectors to include the new destructive name.
924
+
925
+ ### Documentation Changes
926
+
927
+ - Alternate Font Pattern by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/214
928
+ - Added an example to the docs for how to utilize multiple fonts in your application
929
+ - Icon example for button by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/215
930
+ - Added an example to the docs for using icons within a button
931
+ - Component Documentation Structure by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/216
932
+ - The sidebar on the documentation has been updated to better categorize the different components available. Search can still be used to find thing as well.
933
+ - Alpha Color Documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/218
934
+ - Added a new docs page to explain how to handle alpha colors and use `color-mix`
935
+ - Tooltip on disabled Button by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/219
936
+ - Due to a limitation with tooltips on disabled buttons, an example of how to work around this issue was added to the docs
937
+ - Aligned Header Recipe by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/220
938
+ - A new recipe example was added to show how to solve a challenge that may come up
939
+ - Update Logo by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/225
940
+ - Update the top left logo with the new Optics logo.
941
+ - Add a info blurb pointing to the RoleModel Software website
942
+
943
+ ### Bug Fixes
944
+
945
+ - Compound Selector with `::file-selector-button` bug by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/221
946
+ - Due to how buttons were implemented, the styling for the input of type `file` would cause issues when trying to style all buttons.
947
+ - I suspect most projects are not styling this specific element, but if it is, it will need to be updated. Check the Pull Request for details
948
+ - Fix Avatar Squish inside a flex container by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/213
949
+ - The avatar component could get squished if used inside a flex container. This updated it to ensure it would stay the same width and height.
950
+
951
+ ### Dependencies
952
+
953
+ - Dependency updates by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/217
954
+ - Bump ip from 2.0.0 to 2.0.1 by @dependabot in https://github.com/RoleModel/optics/pull/223
955
+ - Both of these changes are for the Storybook documentation. They don't affect the imported styles.
956
+
957
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.5.1...v1.0.0
958
+
959
+ ## [0.5.1] - 2023-09-29
960
+
961
+ ### Base Token Changes
962
+
963
+ - Added missing token for tooltip transition animation by @dallasbpeters in https://github.com/RoleModel/optics/pull/203
964
+ - Tooltips were implemented with a global token in mind, but that was never added.
965
+
966
+ ### New Components
967
+
968
+ - Breadcrumbs by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/205
969
+ - A new Breadcrumb navigation component for showing application route context.
970
+ - Text Pair by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/209
971
+ - A new component to show related text together such as a title and subtitle, or a label and a value.
972
+
973
+ ### Component Changes
974
+
975
+ - Sensible file input styles by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/207
976
+ - The `.form-control` class now supports inputs with a type set to `file` by providing sensible default styles that match other inputs
977
+
978
+ ### Bug Fixes
979
+
980
+ - Added missing token for tooltip transition animation by @dallasbpeters in https://github.com/RoleModel/optics/pull/203
981
+ - Tooltips were implemented with a global token in mind, but that was never added.
982
+ - Safari Mobile Form Control Bug by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/202
983
+ - The box shadows on inputs using the `.form-control` class were not rendering correctly in Safari
984
+ - Hide still-visible checkbox on Firefox by @zoopmaster in https://github.com/RoleModel/optics/pull/204
985
+ - In Firefox, the switch component was still showing the underlying checkbox input.
986
+ - Hide checkbox input when disabled by @zoopmaster in https://github.com/RoleModel/optics/pull/206
987
+ - If the switch was disabled, the checkbox would show up underneath on Safari and Firefox. This has been resolved
988
+ - Fix accordion arrow showing in safari by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/208
989
+ - In Safari, the accordion component was not rendering correctly. The default arrow was still visible and the layout was incorrect.
990
+
991
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.5.0...v0.5.1
992
+
993
+ ## [0.5.0] - 2023-07-27
994
+
995
+ ### Breaking Changes
996
+
997
+ - Remove warning + no border state for button by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/200
998
+ - Combining the `.btn-warning` and `.btn--no-border` class no longer creates a borderless warning button, it creates a normal warning button as if you were only using `.btn-warning`. This is to match the delete button behavior
999
+ - If a button is meant to convey warning, the unfocused un-hovered state should convey that and a borderless warning button wasn't doing that.
1000
+
1001
+ ### Base Token Changes
1002
+
1003
+ - Breakpoint continuity by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/181
1004
+ - Variable versions of the existing sass variables for breakpoints have been added. This allows for usage in cases of max-width or such where a calc may be desired. `@media` queries still require using the sass variables.
1005
+ - Documentation improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/194
1006
+ - `--op-color-on-background-alt` was added to accompany the existing background color tokens.
1007
+ - Add tags component by @dallasbpeters in https://github.com/RoleModel/optics/pull/186
1008
+ - input focus tokens for neutral, info, and notice were added to support focus for all color scales.
1009
+ - Dropdown Encoded Image by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/199
1010
+ - The encoded image token for the arrow on dropdown selects has been updated and a dark mode version was added
1011
+ - Opacity Tokens by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/198
1012
+ - Opacity tokens have been added to support setting various visibility settings.
1013
+ - Size Scale by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/197
1014
+ - A new token for size: `--op-size-unit` has been added for width and height properties to utilize. This ensures sizes are scalable at a global level and are divisible by 4.
1015
+
1016
+ ### New Components
1017
+
1018
+ - Switch by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/183
1019
+ - A new Switch (sometimes referred to as a toggle) component for boolean input is now available
1020
+ - Navbar component by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/191
1021
+ - A Header bar for building your applications navigation is now available along with some example application layouts.
1022
+ - Add tab component by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/195
1023
+ - A Tab component for creating tabbed navigation controls is now available.
1024
+ - Side Panel by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/196
1025
+ - A Side Panel component is now available along with some example application layouts.
1026
+ - Add tags component by @dallasbpeters in https://github.com/RoleModel/optics/pull/186
1027
+ - A Tag component is now available. It is similar to Badge, but has a different semantic intent (that of interaction where badge is for information) and different behavior when buttons are used within it.
1028
+ - Add spinner component by @dallasbpeters in https://github.com/RoleModel/optics/pull/188
1029
+ - A loading spinner component can now be used. Also includes some example application layouts.
1030
+
1031
+ ### Component Changes
1032
+
1033
+ - Select control fix by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/184
1034
+ - The select form control was not respecting background colors set on it. This has been fixed.
1035
+ - Dropdown Encoded Image by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/199
1036
+ - The arrow for the select form control has been changed
1037
+
1038
+ ### Repository Changes
1039
+
1040
+ - Add rule to auto fix on save by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/187
1041
+ - This is a code formatting rule for developing on this project.
1042
+
1043
+ ### Documentation Changes
1044
+
1045
+ - Fix various documentation inconsistencies. by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/182
1046
+ - Some components were missing instructions for selective imports
1047
+ - The customizing and extending sections of each component now show an important notice.
1048
+ - Documentation improvements by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/194
1049
+ - The documentation tool along with other packages for documentation have been updated.
1050
+ - A Table of Contents was added to navigate the documentation easier.
1051
+ - The introduction page was updated to show some project status indicators
1052
+
1053
+ ### New Contributors
1054
+
1055
+ - @dallasbpeters made their first contribution in https://github.com/RoleModel/optics/pull/188
1056
+
1057
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.4.2...v0.5.0
1058
+
1059
+ ## [0.4.2] - 2023-06-15
1060
+
1061
+ ### New Components
1062
+
1063
+ - [TR#8] Accordion by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/178
1064
+ An Accordion component built on the `details` and `summary` elements is now available!
1065
+
1066
+ ### Base Token Changes
1067
+
1068
+ - [TR#8] Accordion by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/178
1069
+ A transition token was added to support the new Accordion Component!
1070
+
1071
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.4.1...v0.4.2
1072
+
1073
+ ## [0.4.1] - 2023-06-07
1074
+
1075
+ ### Breaking Changes
1076
+
1077
+ - Addon change by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/173
1078
+ - Only applicable if you are using the Tom Select Addon and your application does not pull in Tom Select CSS already.
1079
+ - You will need to do that now since the addon does not do that for you. Following the normal Tom Select instructions or following the Addon instructions should be straightforward.
1080
+
1081
+ ### New Components!
1082
+
1083
+ - [TR#93] Tooltips by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/170
1084
+ - A simple tooltip implementation using data attribute has been added. This doesn't solve clipping or edge detection. See the documentation for JS package recommendations if that is needed.
1085
+ - [TR#9] Avatar by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/171
1086
+ - Simple visual or navigable avatar element
1087
+ - [TR#120] Divider by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/172
1088
+ - An easy-to-use class for dividing content in your application. An example use-case is between button sections in a sidebar.
1089
+ - [TR#20] Pagination by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/175
1090
+ - Pagination styles build on the existing button classes for creating consistent navigation controls for paginated data. Also includes instruction for use within a table.
1091
+
1092
+ ### Component Changes
1093
+
1094
+ - Alerts fix by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/177
1095
+ - `.alert-alert` is now an alias of `.alert-danger`. This allows Rails + Devise to work out of the box with the recommended flash layout.
1096
+
1097
+ ### Documentation Changes
1098
+
1099
+ - Fix Documentation Deployment by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/167
1100
+ - The documentation site was not deploying correctly
1101
+ - [TR#119] Import Instructions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/168
1102
+ - A graph of which components depend on others has been added to the Selective Imports documentation.
1103
+ - Each component now specifies what other components it requires and includes instructions for importing by itself if you are using selective imports.
1104
+ - Fix Sidebar Recipe Documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/174
1105
+ - The examples for how to customize the sidebar were not working correctly. They are now fixed and using the latest sidebar version.
1106
+
1107
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.4.0...v0.4.1
1108
+
1109
+ ## [0.4.0] - 2023-05-22
1110
+
1111
+ ### Breaking Changes
1112
+
1113
+ - [T#17] Tables Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/155
1114
+ - The color of the header was changed to be a more muted color
1115
+ - The density options are changed to use height instead of padding.
1116
+ - If your application is customizing this component, I recommend reviewing the PR for any changes.
1117
+ - [TR#12] Button Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/156
1118
+ - **The default `btn` state is now what `btn-secondary` was.**
1119
+ - `btn` will now show the primary color on hover or active state.
1120
+ - **The default button size is now large instead of medium.**
1121
+ - **`btn--outline` has been removed in favor of using the `btn` or `btn--active` styles**
1122
+ - `btn--active` was added to create active states.
1123
+ - `btn--icon-with-label` was added to create a stacked button with icon.
1124
+ - A Warning button was added.
1125
+ - All button styles have been adjusted to reflect current Figma styles.
1126
+ - I recommend reviewing the PR for any changes as this changes existing implementation as well as affects customization considerations.
1127
+ - [TR#22] Flash Alert Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/158
1128
+ - The Alert component has been changed to be outlined by default with an option for filled instead of the other way round.
1129
+ - The Alert component has an added option so it can be used as a flash message `alert--flash`.
1130
+ - **The Flash component has been removed in favor of using the Alert Component**
1131
+ - I recommend reviewing the PR for any changes as this changes existing implementation, removes a component as well as affects customization considerations.
1132
+ - [TR#107] Sidebar Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/160
1133
+ - **The Subtle Primary option has been removed.**
1134
+ - **Sidebar item styles have been removed in favor of just using the existing button styles in the sidebar.**
1135
+ - A new compact version of the sidebar has been added as an option between drawer and rail.
1136
+ - I recommend reviewing the PR for any changes as this changes existing implementation as well as affects customization considerations.
1137
+ - [TR#14] Modal Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/159
1138
+ - **The Modal addon has been removed.**
1139
+ - Modal Component has been added!
1140
+ - I recommend reviewing the PR for any changes If you are using the existing addon and need to switch to using the component.
1141
+ - [TR#21] Form Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/164
1142
+ - A no Border variation of form controls has been added.
1143
+ - Size modifiers for small, medium, and large (with large being default) have been added.
1144
+ - The focus states of form controls have been updated to match buttons in a more consistent way.
1145
+ - I recommend reviewing the PR for any changes as the placeholder selector interface for customization has changed significantly.
1146
+
1147
+ ### Component Changes
1148
+
1149
+ - [TR#11] Update badge to reflect design by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/152
1150
+ - A white box shadow has been added when using the badge on a button for things like a notification indicator.
1151
+ - Icons used inside of a badge will have a smaller font size.
1152
+ - Add confirm dialog with documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/157
1153
+ - A new component for Confirm Dialogs has been created!
1154
+ - This can be used with something like https://github.com/RoleModel/turbo-confirm for a rails implementation
1155
+
1156
+ ### Bug Fixes
1157
+
1158
+ - Table token bug by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/163
1159
+ - There was a token being used that was incorrect. It was a rare case where using a checkbox in a table header will highlight the header when checked. The text color was using a non-existent token.
1160
+ - Button Focus Fix by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/162
1161
+ - Focus on Buttons was triggering on both click and keyboard navigation. This fix changes it to only trigger on keyboard or assistive device (I.E. screen reader) navigation.
1162
+
1163
+ ### Documentation Changes
1164
+
1165
+ - Storybook upgrade by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/161
1166
+ - Storybook has been updated to the latest version (v7)
1167
+ - As part of this update, the documentation interface has been simplified. Items with no relevance to this project have been hidden and the documentation pages live as their own items in the sidebar instead of being hidden in the docs tab
1168
+ - All the documentation has been refactored to clean up and simplify writing new or modifying it. It is also organized to reflect the sidebar organization.
1169
+ - [TR#18] Card Revisions by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/154
1170
+ - The Card documentation has been updated to better reflect real world usage. This mainly removed the color from the example as it was potentially misleading.
1171
+ - [TR#116] Token Naming Structure Docs by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/165
1172
+ - The token documentation has been updated to define and explain the structure of how we name our tokens along with a few examples.
1173
+ - [TR#117] Folder Structure Documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/166
1174
+ - A new documentation page has been added to explain how to organize your css and the import order that is recommended.
1175
+
1176
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.3.1...v0.4.0
1177
+
1178
+ ## [0.3.1] - 2023-03-16
1179
+
1180
+ ### Component Changes
1181
+
1182
+ - Fix token usage for flash by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/153
1183
+ - Minor bug fix with the flash animation token not being set properly.
1184
+
1185
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.3.0...v0.3.1
1186
+
1187
+ ## [0.3.0] - 2023-03-09
1188
+
1189
+ ### Breaking Changes
1190
+
1191
+ - [GHI #109] Button API Fix by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/130
1192
+ - If you are customizing `--_rm-font-small`, `--_rm-font-medium`, or `--_rm-font-large`, you will need to rename them to `-_rm-btn-font-small`, `-_rm-btn-font-medium`, `-_rm-btn-font-large`
1193
+
1194
+ - [GHI #131] Rename rm prefix to op by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/132
1195
+ - All token name prefixes have changed from `--rm` to `--op`
1196
+ - [GHI #133] Revise Layout classes by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/141
1197
+ - `.app-wrapper` is now `.app-with-sidebar`
1198
+ - `.app__main` is now `.app-body`
1199
+ - `.page__header` is now `.app__header`
1200
+ - `.page__content` is now `.app__content`
1201
+ - `.page__footer` is now `.app__footer`
1202
+ - [TR#27] Revised Tokens by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/150
1203
+ - Input Height tokens have been adjusted. You may want to adjust them.
1204
+ - `--op-input-height-small: 2.8rem; // 28px`
1205
+ - `--op-input-height-medium: 3.6rem; // 36px`
1206
+ - `--op-input-height-large: 4rem; // 40px`
1207
+ - `--op-input-height-x-large: 8.4rem; // 84px`
1208
+ - Transition tokens have been refactored to include the entire transition instead of just the duration. If you are customizing a component, you may need to refactor.
1209
+ - `--op-transition-input: all 120ms ease-in;`
1210
+ - `--op-transition-sidebar: all 200ms ease-in-out;`
1211
+ - `--op-transition-modal: all 300ms ease-in;`
1212
+ - `--op-transition-panel: right 400ms ease-in;`
1213
+ - The navigation transition token was adjusted.
1214
+ - `--op-transition-navigation` is removed
1215
+ - `--op-transition-sidebar` now does what `--op-transition-navigation` did
1216
+ - The flash transition token was renamed to reflect it is an animation
1217
+ - `--op-transition-flash` is now `--op-animation-flash` and it includes the full animation options instead of just the duration.
1218
+
1219
+ - [TR#28] Font Tokens by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/149
1220
+ - Added a new stop for 2rem (20px). This is set to `--op-font-x-large` which means all steps above this have been bumped up `2x -> 3x` etc. Any token `large` and above will need to be revised.
1221
+ - [GHI #125] Enhanced Color Support by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/140
1222
+ - `--op-border-color` token has been changed to point to `-op-color-neutral-plus-five` (used to be three). If you want to revert it, you will need to override it back.
1223
+ - All color scale tokens (light and dark mode) luminosities have been adjusted.
1224
+
1225
+ ### Base Token Changes
1226
+
1227
+ - [GHI #131] Rename rm prefix to op by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/132
1228
+ - All token name prefixes have changed from `--rm` to `--op`
1229
+ - [TR#27] Revised Tokens by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/150
1230
+ - Input Height tokens have been adjusted.
1231
+ - Transition tokens have been refactored to include the entire transition instead of just the duration
1232
+ - The navigation transition token was remove as it was not being used.
1233
+ - The flash transition token was renamed to reflect it is an animation
1234
+ - Added new Radius stop (12px)
1235
+ - [TR#28] Font Tokens by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/149
1236
+ - Added a 2x-small font token set to `1rem`
1237
+ - Added a new stop for 2rem (20px). This is set to `--op-font-x-large` which means all steps above this have been bumped up `2x -> 3x` etc.
1238
+ - [GHI #125] Enhanced Color Support by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/140
1239
+ - `--op-border-color` token has been changed to point to `-op-color-neutral-plus-five` (used to be three)
1240
+
1241
+ ### Theme Token Changes
1242
+
1243
+ - [GHI #131] Rename rm prefix to op by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/132
1244
+ - All token name prefixes have changed from `--rm` to `--op`
1245
+ - [GHI #125] Enhanced Color Support by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/140
1246
+ - All the default scale colors have been adjusted and optimized to maintain contrast.
1247
+ - on-alt versions for each scale step have been added
1248
+
1249
+ ### Layout Changes
1250
+
1251
+ - [GHI #133] Revise Layout classes by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/141
1252
+ - The layout classes have been renamed to be more intention revealing and intuitive
1253
+
1254
+ ### Component Changes
1255
+
1256
+ - [GHI #109] Button API Fix by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/130
1257
+ - The internal size variables were not named correctly. This PR added the `btn` prefix into the variable names.
1258
+
1259
+ ### Addon Changes
1260
+
1261
+ - [GHI #125] Enhanced Color Support by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/140
1262
+ - The dark mode overrides for modal and panel were moved to be in their respective addons and therefore not included by default in the dark mode overrides.
1263
+
1264
+ ### Documentation Changes
1265
+
1266
+ - [GHI #125] Enhanced Color Support by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/140
1267
+ - Added better Color documentation. color, on-color, and on-color-alt are now grouped together for easier reference.
1268
+
1269
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.2.5...v0.3.0
1270
+
1271
+ ## [0.2.5] - 2023-03-07
1272
+
1273
+ ### Utility Changes
1274
+
1275
+ - [GHI #22] Color, Utility, and Token Documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/148
1276
+ - `.self-baseline` was added to round out the existing `.self-...` utilities
1277
+
1278
+ ### Repository Changes
1279
+
1280
+ - [GHI #142] Release Template by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/144
1281
+ - Release Notes can be auto categorized by label now.
1282
+
1283
+ ### Documentation Changes
1284
+
1285
+ - [GHI #101] Font and Line Height by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/145
1286
+ - Added Documentation for font tokens
1287
+ - Fix the storybook building by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/146
1288
+ - The documentation was not compiling correctly
1289
+ - [GHI #108] Documentation Updates by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/147
1290
+ - Added a note on SASS Compilers
1291
+ - Cleaned up syntax highlighting
1292
+ - [GHI #22] Color, Utility, and Token Documentation by @Jeremy-Walton in https://github.com/RoleModel/optics/pull/148
1293
+ - Documentation for all colors, tokens, and utilities has been added. View it at https://docs.optics.rolemodel.design/
1294
+
1295
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.2.4...v0.2.5
1296
+
1297
+ ## [0.2.4] - 2023-02-17
1298
+
1299
+ ### Refining Changes
1300
+
1301
+ - Prevent form-error from shifting form-group [fix #138] by @OutlawAndy in https://github.com/RoleModel/optics/pull/139
1302
+ - Form groups in a form were shifting when errors displayed due to grid usage.
1303
+ - Checkboxes and Radios were not laying out correctly inside of form groups
1304
+
1305
+ ### New Contributors
1306
+
1307
+ - @OutlawAndy made their first contribution in https://github.com/RoleModel/optics/pull/139
1308
+
1309
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.2.3...v0.2.4
1310
+
1311
+ ## [0.2.3] - 2023-02-13
1312
+
1313
+ A couple of Minor bug fixes and a project rename!
1314
+
1315
+ ### Repo Updates
1316
+
1317
+ - Rename project and update documentation https://github.com/RoleModel/optics/pull/128 by @Jeremy-Walton
1318
+
1319
+ ### Refining Changes
1320
+
1321
+ - Form Group Refactor https://github.com/RoleModel/optics/pull/135 by @Jeremy-Walton
1322
+ - Form controls should not set a `grid-column` when they are not in a `form-group`
1323
+ - Deployment Strategy https://github.com/RoleModel/optics/pull/134 by @Jeremy-Walton
1324
+ - In order to support projects who pull private RoleModel packages from GitHub Packages, we need to publish to both locations so organization scopes still work.
1325
+ - Select Bug https://github.com/RoleModel/optics/pull/127 by @Jeremy-Walton
1326
+ - The Select dropdown had an issue where the arrow would overlap contents strangely. This has been resolved and cleaned up.
1327
+ - When using a multiple select, the dropdown arrow is hidden and the input gets a larger minimum height.
1328
+
1329
+ ### Breaking Changes
1330
+
1331
+ Since the project repository and package have a new name, the project will need to be added to your `package.json` as `@rolemodel/optics`.
1332
+ Additionally, all imports from the package will need to be updated.
1333
+ E.G.
1334
+ `@import '@rolemodel/rolemodel-design-system';` changes to `@import '@rolemodel/optics';`
1335
+ `@import '@rolemodel/rolemodel-design-system/dist/scss/rolemodel-design-system';` changes to `@import '@rolemodel/optics/dist/scss/optics';`
1336
+ `@import '@rolemodel/rolemodel-design-system/dist/scss/addons/...';` changes to `@import '@rolemodel/optics/dist/scss/addons/...';`
1337
+
1338
+ The existing package `@rolemodel/rolemodel-design-system` will still work so you won't need to update immediately. However, all versions after `v0.1.3-beta` will be published as `@rolemodel/optics`.
1339
+
1340
+ Another minor note is that we are now more closely following [Semantic Versioning](https://semver.org/), though we will not update the major number on breaking changes until we have reached a `v1.0.0` at which point we will follow it normally. All breaking changes will be documented in release notes.
1341
+
1342
+ **Full Changelog**: https://github.com/RoleModel/optics/compare/v0.1.3-beta...v0.2.3
1343
+
1344
+ ## [0.1.3-beta] - 2023-01-12
1345
+
1346
+ ### Repo Updates
1347
+
1348
+ - Version in Docs https://github.com/RoleModel/rolemodel-design-system/pull/123 by @Jeremy-Walton
1349
+ - The documentation now includes the current version of the design system on the welcome page.
1350
+ - Documentation dependency updates by @dependabot
1351
+ - Bump json5 from 1.0.1 to 1.0.2 https://github.com/RoleModel/rolemodel-design-system/pull/122
1352
+
1353
+ ### Refining Changes
1354
+
1355
+ - Colors and Scales https://github.com/RoleModel/rolemodel-design-system/pull/117 by @Jeremy-Walton
1356
+ - There were example colors (blue, green, yellow, etc) that existed but were not needed. They have been removed.
1357
+ - The alert colors are no longer based on those example colors. Instead they each (danger, warning, notice, info) have their own `HSL` values that can be set in your theme.
1358
+ - As we have used the color scales and needed to customize them, it was clear we needed more luminosity options. Instead of limiting ourselves to a set luminosity scale, we have removed those scales and set the semantic scales directly to luminosity values. This allows for much more flexibility in overriding as well as simplifying the number of tokens in the system. It also removes the potential for someone using one of those variables directly (which wasn't really the intention of it). You can still use an `HSL` value directly as needed but should name it so it can be handled in themes and theme modes. e.g. `--rm-my-custom-component-color: hsl(var(--rm-color-primary-h), hsl(--rm-color-primary-s), 42%);`
1359
+ - Forms Revisited https://github.com/RoleModel/rolemodel-design-system/pull/118 by @Jeremy-Walton
1360
+ - All of the form classes have been refactored to simplify their usage and implementation.
1361
+ - All input elements should get the `.form-control` class and they will each be styled correctly based on their type.
1362
+ - `.form__group` is now `.form-group` since it is not an element according to BEM practices.
1363
+ - `.form__error` is now `.form-error` since it is not an element according to BEM practices.
1364
+ - `.form__label` is now `.form-label` since it is not an element according to BEM practices.
1365
+ - `.form__input--error` is now `.form-group--error` since it is intended to be used at the group level.
1366
+ - `.form__hint` is now `.form-hint` since it is not an element according to BEM practices.
1367
+ - `.form__error-summary` is now `.form-error-summary` since it is not an element according to BEM practices.
1368
+ - Form elements now have a focus style!
1369
+ - Tom Select Revisited https://github.com/RoleModel/rolemodel-design-system/pull/120 by @Jeremy-Walton
1370
+ - The Tom Select Add on has been rewritten to only override and apply our scale colors in the appropriate places. It should look and feel more integrated out of the box.
1371
+ - Buttons Revisited https://github.com/RoleModel/rolemodel-design-system/pull/119 by @Jeremy-Walton
1372
+ - Buttons now have a focus state!
1373
+ - The `.btn--no-border` modifier was setting the font weight to bold which was too bold as a default. This has been removed as it didn't make sense as the correct behavior.
1374
+
1375
+ ### Breaking Changes
1376
+
1377
+ - Colors and Scales https://github.com/RoleModel/rolemodel-design-system/pull/117 by @Jeremy-Walton
1378
+ - With the removal of the luminosity scales, it is going to require any customization of your scales (primary, neutral, warning, danger, info, notice) to be refactored. Additionally, any usage of those luminosity values will need to be changed.
1379
+ - Forms Revisited https://github.com/RoleModel/rolemodel-design-system/pull/118 by @Jeremy-Walton
1380
+ - All of the form classes have been refactored to simplify their usage and implementation. As a result, their classes are changed.
1381
+ - `.form__input` no longer exists.
1382
+ - All input elements should get the `.form-control` class and they will each be styled correctly based on their type.
1383
+ - `.form__group` is now `.form-group`
1384
+ - `.form__error` is now `.form-error`
1385
+ - `.form__label` is now `.form-label`
1386
+ - `.form__input--error` is now `.form-group--error`
1387
+ - `.form__hint` is now `.form-hint`
1388
+ - `.form__error-summary` is now `.form-error-summary`
1389
+ - If you have customized form controls, this change will require a refactor of those customizations.
1390
+ - Tom Select Revisited https://github.com/RoleModel/rolemodel-design-system/pull/120 by @Jeremy-Walton
1391
+ - If you are customizing Tom Select in any way, you may need to refactor that to avoid conflict with this simplifying change.
1392
+ - It may actually reduce your need to override since it should be styling things better out of the box.
1393
+ - Buttons Revisited https://github.com/RoleModel/rolemodel-design-system/pull/119 by @Jeremy-Walton
1394
+ - If you wanted the bold text on a button with no border, you will need to use the following css to add that behavior back.
1395
+ ```css
1396
+ %btn-global {
1397
+ &.btn--no-border {
1398
+ font-weight: var(--rm-font-weight-bold);
1399
+ }
1400
+ }
1401
+ ```
1402
+
1403
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.1.2-beta...v0.1.3-beta
1404
+
1405
+ ## [0.1.2-beta] - 2023-01-06
1406
+
1407
+ ### Repo Updates
1408
+
1409
+ - Code Linting https://github.com/RoleModel/rolemodel-design-system/pull/116 by @Jeremy-Walton
1410
+ - There is now CSS and JS (docs) code linting to ensure code quality in the project.
1411
+ - There are also CI tests to verify linting was checked.
1412
+ - PR Template https://github.com/RoleModel/rolemodel-design-system/pull/121 by @Jeremy-Walton
1413
+ - With the addition of linting, additional sanity checks have been added to the PR Template to help ensure they are run and work.
1414
+ - Documentation dependency updates by @dependabot
1415
+ - Bump loader-utils from 1.4.0 to 1.4.2 https://github.com/RoleModel/rolemodel-design-system/pull/106
1416
+ - Bump decode-uri-component from 0.2.0 to 0.2.2 https://github.com/RoleModel/rolemodel-design-system/pull/110
1417
+
1418
+ ### New Components
1419
+
1420
+ - Alert https://github.com/RoleModel/rolemodel-design-system/pull/121 by @Jeremy-Walton
1421
+ - Alert components that can act as highlights or banners have been added.
1422
+ - They support three styles: filled, muted, outlined.
1423
+ - They support four colors: Warning, Danger, Info, Notice
1424
+ - The can be customized to have titles, icons, and close if you want to build dismissible functionality, and any combination of using or not using those!
1425
+ - Button Group https://github.com/RoleModel/rolemodel-design-system/pull/104 by @Jeremy-Walton
1426
+ - Button groups allow you to create connected buttons in a row.
1427
+ - It also introduces a button group toolbar that acts as a collection of button groups with wrapping built in. E.G. Rich text editor toolbar
1428
+
1429
+ ### Refining Changes
1430
+
1431
+ - Standardize Utilities https://github.com/RoleModel/rolemodel-design-system/pull/105 by @Jeremy-Walton
1432
+ - The line we have generally drawn is that utilities should be for layout and position, not for look and feel. Therefore, the font size and weight, and shadow utilities are deprecated. This moves us more in line with that goal.
1433
+ - Checkbox and Radio Simplification https://github.com/RoleModel/rolemodel-design-system/pull/107 by @Jeremy-Walton
1434
+ - The implementation of these controls has been simplified and cleaned up.
1435
+ - They no longer animate when selected, but their look is much more consistent and implementation is way simpler.
1436
+ - With a simplified implementation, the `indeterminate state` for checkboxes is now supported and documented!
1437
+
1438
+ ### Bug Fixes
1439
+
1440
+ - Color Scales https://github.com/RoleModel/rolemodel-design-system/pull/121 by @Jeremy-Walton
1441
+ - Some alert scales were missing luminosity stops
1442
+
1443
+ ### Breaking Changes
1444
+
1445
+ - Standardize Utilities https://github.com/RoleModel/rolemodel-design-system/pull/105 by @Jeremy-Walton
1446
+ - If you are using the font size, font weight, or shadow utilities, they no longer exist. The underlying tokens still exist are should be used, but the utility classes are removed
1447
+ - Checkbox and Radio Simplification https://github.com/RoleModel/rolemodel-design-system/pull/107 by @Jeremy-Walton
1448
+ - This is less of a breaking change but if your app was customizing these controls, you may need to review and/or refactor.
1449
+
1450
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.1.1-beta...v0.1.2-beta
1451
+
1452
+ ## [0.1.1-beta] - 2022-11-04
1453
+
1454
+ ### Refining Changes
1455
+
1456
+ - The default theme now uses RoleModel blue as the primary color.
1457
+ - Semantic Stops https://github.com/RoleModel/rolemodel-design-system/pull/102 by @Jeremy-Walton
1458
+ - Semantic tokens now use words instead of numbers so `--rm-color-primary-plus-3` would read `--rm-color-primary-plus-three`
1459
+ - We now have plus-eight down through minus-eight
1460
+ - Semantic utilities like `.background-primary-plus-3` are now deprecated as a part of trying to move away from the look and feel utilities.
1461
+
1462
+ ### Breaking Changes
1463
+
1464
+ - The Semantic utilities are no longer available. `.background-primary-plus-3` etc. If you used them in places such as cards, consider making that style the default card style or making a custom card class. The tokens they used are still very much available and encouraged to be used.
1465
+ - Semantic stops have more fidelity which means plus 3 doesn't mean what it used to mean. Here is a mapping reference if you want to maintain what you may have been using.
1466
+ Anything using `plus-3` should now use `plus-seven`
1467
+ Anything using `plus-2` should now use `plus-four`
1468
+ Anything using `plus-1` should now use `plus-three`
1469
+ Anything using `minus-3` should now use `minus-seven`
1470
+ Anything using `minus-2` should now use `minus-five`
1471
+ Anything using `minus-1` should now use `minus-three`
1472
+ Anything using `on-plus-3` should now use `on-plus-seven`
1473
+ Anything using `on-plus-2` should now use `on-plus-four`
1474
+ Anything using `on-plus-1` should now use `on-plus-three`
1475
+ Anything using `on-minus-3` should now use `on-minus-seven`
1476
+ Anything using `on-minus-2` should now use `on-minus-five`
1477
+ Anything using `on-minus-1` should now use `on-minus-three`
1478
+
1479
+ If your application is adjusting the default scales, you will need to compare the new values to what you used to determine the best mapping for your needs.
1480
+
1481
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.1.0-beta...v0.1.1-beta
1482
+
1483
+ ## [0.1.0-beta] - 2022-10-19
1484
+
1485
+ ### Repo Updates
1486
+
1487
+ - Issues Templates https://github.com/RoleModel/rolemodel-design-system/pull/73 by @Jeremy-Walton
1488
+ - It is now easier to report a bug or request a new feature! Issue templates prefill the form to help you describe what you are after.
1489
+ - Take a look here: [New Issue](https://github.com/RoleModel/rolemodel-design-system/issues/new/choose)
1490
+
1491
+ ### New Components
1492
+
1493
+ - Tables https://github.com/RoleModel/rolemodel-design-system/pull/75 and https://github.com/RoleModel/rolemodel-design-system/pull/91 by @Jeremy-Walton and @zoopmaster
1494
+ - Tables have been overhauled. They support multiple variations, data densities, striping, and more.
1495
+ - They also support fixed headers and footers, along with a fixed height and different combinations of those.
1496
+ - Sidebar https://github.com/RoleModel/rolemodel-design-system/pull/83 and https://github.com/RoleModel/rolemodel-design-system/pull/97 by @Jeremy-Walton
1497
+ - Sidebar has been completely rewritten from the ground up. It now supports section titles, dividers, active and hover states, drawer and rail states, and responsive support to transition between the drawer and the rail on the medium breakpoint.
1498
+ - Layout by @Jeremy-Walton
1499
+ - There are now Layout classes to provide support for sidebars along with sticky headers and footers in your application.
1500
+
1501
+ ### Refining Changes
1502
+
1503
+ - Dark Mode Alert Scales https://github.com/RoleModel/rolemodel-design-system/pull/88 by @Jeremy-Walton
1504
+ - The alert scales now support dark mode. This means that tables and flash messages will properly switch to the correct dark version of the colors.
1505
+ - Form Group and Error Messages https://github.com/RoleModel/rolemodel-design-system/pull/90 by @Jeremy-Walton
1506
+ - The `.form__group` class now uses grid to lay out the contents within it. e.g. `.form__input, .form__hint, etc.`. Errors, hints, and inputs have been refines to display more consistently. This also removes the need for using margins and other spacing techniques inside the form group. by @Jeremy-Walton
1507
+ - Customization API https://github.com/RoleModel/rolemodel-design-system/pull/93 by @Jeremy-Walton
1508
+ - All the components were written in a way that allowed them to be overridden easily and flatly. After implementing this, we realized it was leading to more confusion as to how to use it. All the component implementations have been simplified to just use standard CSS and SASS patterns with a few minor exceptions that are clearly documented.
1509
+ - Better Documentation by @Jeremy-Walton
1510
+ - Recipes is a new section that gives examples of how to structure the layout of your application with or without a sidebar.
1511
+ - There is now a Recipe showing examples of customized sidebars to provide a starting point if your application needs to redefine the look of its sidebar.
1512
+
1513
+ ### Bug Fixes
1514
+
1515
+ - Tom Select Single https://github.com/RoleModel/rolemodel-design-system/pull/86 by @Jeremy-Walton
1516
+ - The Tom Select addon only overrides the multi-select variant properly. The single select variant now matches styles correctly!
1517
+ - Button Fixes https://github.com/RoleModel/rolemodel-design-system/pull/87 and https://github.com/RoleModel/rolemodel-design-system/pull/95 by @Jeremy-Walton
1518
+ - This fixes buttons so that at mobile breakpoints, they will size up to reflect best practices on minimum button sizes on mobile.
1519
+ - Buttons inside of a flex container were not respecting width settings. They now respect it and do not squish in the container.
1520
+
1521
+ ### Breaking Changes
1522
+
1523
+ - Tables
1524
+ - There shouldn't be any issues with this as the base classes didn't change, but the implementation did change so you may want to review.
1525
+ - Sidebar
1526
+ - If your app was using the existing sidebar styles, it will need to be completely rewritten to match the newly expected structure.
1527
+ - Alert Scales
1528
+ - The alert scale semantic variables will now change in dark mode following a similar pattern to the primary and neutral scales. If your app uses them outside of the flash component, you may want to review them and verify things still work as intended.
1529
+ - Form Group and Error Messages
1530
+ - If your app uses simple form helpers to construct your form groups, you will need to ensure it places validation errors underneath the input instead of inline with the label. This was changed to prevent overlap and wrapping issues found in larger error messages.
1531
+ The output should generally look like the following:
1532
+ ```
1533
+ <div class="form__group form__input--error">
1534
+ <label class="form__label" for="random">A Label</label>
1535
+ <input type="text" placeholder="text" id="random" class="form__input">
1536
+ <span class="form__error">Can't be blank</span>
1537
+ <div class="form__hint">A Hint</div>
1538
+ </div>
1539
+ ```
1540
+ - Customization API
1541
+ - If your app is customizing a base component, you will need to refactor the override implementation to change things correctly.
1542
+ - Buttons are the major component that will require refactoring work if you are overriding them. If you are just using the existing styles, you should be fine as the HTML interface is still the same `.btn, .btn-primary, etc`.
1543
+
1544
+ ### New Contributors
1545
+
1546
+ - @zoopmaster made their first contribution in https://github.com/RoleModel/rolemodel-design-system/pull/91
1547
+
1548
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.10-beta...v0.1.0-beta
1549
+
1550
+ ## [0.0.10-beta] - 2022-09-01
1551
+
1552
+ - API Update and fixes by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/80
1553
+ - Major changes to the button, badge, and card implementation
1554
+
1555
+ ### Breaking Changes
1556
+
1557
+ - From a usage perspective, no classes changed
1558
+ - From a customizing or overriding perspective, how you achieve that is vastly different
1559
+
1560
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.9-beta...v0.0.10-beta
1561
+
1562
+ ## [0.0.9-beta] - 2022-08-31
1563
+
1564
+ - [GHI #77] Remove Placeholder Selectors by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/78
1565
+
1566
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.8-beta...v0.0.9-beta
1567
+
1568
+ ## [0.0.8-beta] - 2022-08-22
1569
+
1570
+ - [GHI #36] Improved Importing and documentation by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/55
1571
+ - Remove tom select, modal, and panel from being imported by default.
1572
+ - Add documentation for "Addons" explaining ^ and how to use them.
1573
+ - Add index files for tokens and components to allow for importing the whole folder instead of all files.
1574
+ - [GHI #23] Theme Switching by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/56
1575
+ - Documentation now allows you to change light and dark mode.
1576
+ - Data Attributes for controlling which theme and what mode your app is using have been added.
1577
+ - Add documentation for how to theme, customize dark and light mode, and use the above-mentioned data attributes.
1578
+ - Deprecate `data-allow-dark-mode-preference='false'` in favor of `data-theme-mode='light'`.
1579
+ - [GHI #58] Add MIT License by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/64
1580
+ - [GHI #59] Badges by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/63
1581
+ - New component has been added!
1582
+ - Documentation is included.
1583
+ - [GHI #62] Center modal class by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/67
1584
+ - The modal addon assumed utility classes were applied in the HTML instead of just defining the style.
1585
+ - [GHI #61] Button Icon with Size by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/66
1586
+ - Buttons using the icon and size modifiers now scale correctly
1587
+ - [GHI #60] Use real token and fix default icon vertical alignment by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/65
1588
+ - Added documentation for existing icon styles.
1589
+ - Fix potential alignment issues by standardizing line height and vertical alignment of icons.
1590
+ - [GHI #22] Flash Documentation by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/68
1591
+ - Added documentation for existing flash alert styles.
1592
+ - Simplified HTML structure.
1593
+
1594
+ ### Breaking Changes
1595
+
1596
+ - Tom Select is no longer imported automatically. See Addon Documentation for how to import it if your app needs it.
1597
+ - Panel and Modal are no longer imported automatically. See Addon Documentation for how to import them if your app needs them.
1598
+ - Deprecated `data-allow-dark-mode-preference='false'`. You can achieve the same effect by setting `data-theme-mode='light'`.
1599
+ - Flash message HTML structure has been simplified. See new documentation on what is expected.
1600
+
1601
+ ### Documentation
1602
+
1603
+ https://rolemodel.github.io/rolemodel-design-system
1604
+
1605
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.7-beta...v0.0.8-beta
1606
+
1607
+ ## [0.0.7-beta] - 2022-08-11
1608
+
1609
+ - Generate token json by @NathanSadler in https://github.com/RoleModel/rolemodel-design-system/pull/53 / https://github.com/RoleModel/rolemodel-design-system/pull/54
1610
+ - Generate the json token file automatically rather than having to manually keep it up to date.
1611
+ - This file can be ingested or read by your code for whatever purposes you may have.
1612
+ - Storybook by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/47
1613
+ - New Documentation that can be found on https://rolemodel.github.io/rolemodel-design-system !
1614
+ - All the existing documentation has been migrated to Storybook.
1615
+ - This allows for interaction with component docs and even embedding of examples elsewhere.
1616
+
1617
+ ### New Contributors
1618
+
1619
+ - @NathanSadler made their first contribution in https://github.com/RoleModel/rolemodel-design-system/pull/53 and https://github.com/RoleModel/rolemodel-design-system/pull/54
1620
+
1621
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.6-beta...v0.0.7-beta
1622
+
1623
+ ## [0.0.6-beta] - 2022-07-28
1624
+
1625
+ - Material Symbols Update by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/50
1626
+ - Pull from CDN instead of using a package
1627
+ - [GHI #39] Install Instructions by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/51
1628
+ - Simple installation instructions added the the README
1629
+ - [GHI #46] Shadows by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/52
1630
+ - Improve our shadow tokens and utilities
1631
+
1632
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.5-beta...v0.0.6-beta
1633
+
1634
+ ## [0.0.5-beta] - 2022-07-28
1635
+
1636
+ - [GHI #8] Transitions and Animations by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/44
1637
+ - Make tokens for transitions
1638
+ - Move flash animation to base tokens file
1639
+ - Feedback updates by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/42
1640
+ - Add background: none and cursor: pointer properties to button in base
1641
+ - Update forms to include form__inline-group, form__color, form__textarea, and read-only versions of input, textarea, color, and dropdown
1642
+ - Update PR template to include sanIty checks
1643
+ - Add font and space scale units to allow for component-specific overriding.
1644
+ - Add plus and minus max to semantic scales
1645
+ - Update token structure docs to include all current tokens
1646
+ - Clean up card styles and add documentation
1647
+ - Add documentation for the scale overriding
1648
+ - Specify scss for material symbols import by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/48
1649
+ - Prepare package for release by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/49
1650
+
1651
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.4-beta...v0.0.5-beta
1652
+
1653
+ ## [0.0.4-beta] - 2022-07-11
1654
+
1655
+ - Scale simplification by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/32
1656
+ - [GHI #11] Borders and Outlines by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/33
1657
+ - [GHI #36] Add ability to disable dark mode by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/37
1658
+ - [GHI #7] Forms by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/34
1659
+ - [GHI#35] Better reset and base by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/38
1660
+
1661
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.3-beta...v0.0.4-beta
1662
+
1663
+ ## [0.0.3-beta] - 2022-06-23
1664
+
1665
+ - Fix bugs by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/28
1666
+ - [GHI #10] Buttons by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/29
1667
+ - Bump version number by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/31
1668
+
1669
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.2-beta...v0.0.3-beta
1670
+
1671
+ ## [0.0.2-beta] - 2022-06-21
1672
+
1673
+ - [GHI #2] Fix Class Typo by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/12
1674
+ - [GHI #17] Breakpoint values by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/18
1675
+ - [GHI #15] Color Scales by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/20
1676
+ - Change luminosity scale by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/24
1677
+ - [GHI #6] Tom Select by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/13
1678
+ - Set breakpoints to pixel values by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/25
1679
+ - [GHI #21] File Structure by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/26
1680
+ - Prepare for release by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/27
1681
+
1682
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.1-beta...v0.0.2-beta
1683
+
1684
+ ## [0.0.1-beta] - 2022-06-07
1685
+
1686
+ - Various updates by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/5
1687
+
1688
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.11-alpha...v0.0.1-beta
1689
+
1690
+ ## [0.0.11-alpha] - 2022-06-07
1691
+
1692
+ - Change to NPM by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/9
1693
+
1694
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.10-alpha...v0.0.11-alpha
1695
+
1696
+ ## [0.0.10-alpha] - 2022-04-14
1697
+
1698
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.9-alpha...v0.0.10-alpha
1699
+
1700
+ ## [0.0.9-alpha] - 2022-03-31
1701
+
1702
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.8-alpha...v0.0.9-alpha
1703
+
1704
+ ## [0.0.8-alpha] - 2022-03-31
1705
+
1706
+ - Dist configuration by @Jeremy-Walton in https://github.com/RoleModel/rolemodel-design-system/pull/1
1707
+
1708
+ ### New Contributors
1709
+
1710
+ - @Jeremy-Walton made their first contribution in https://github.com/RoleModel/rolemodel-design-system/pull/1
1711
+
1712
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.7-alpha...v0.0.8-alpha
1713
+
1714
+ ## [0.0.7-alpha] - 2022-03-12
1715
+
1716
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.6-alpha...v0.0.7-alpha
1717
+
1718
+ ## [0.0.6-alpha] - 2022-03-11
1719
+
1720
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.5-alpha...v0.0.6-alpha
1721
+
1722
+ ## [0.0.5-alpha] - 2022-03-11
1723
+
1724
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.4-alpha...v0.0.5-alpha
1725
+
1726
+ ## [0.0.4-alpha] - 2022-03-11
1727
+
1728
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.3-alpha...v0.0.4-alpha
1729
+
1730
+ ## [0.0.3-alpha] - 2022-03-10
1731
+
1732
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.2-alpha...v0.0.3-alpha
1733
+
1734
+ ## [0.0.2-alpha] - 2022-03-09
1735
+
1736
+ **Full Changelog**: https://github.com/RoleModel/rolemodel-design-system/compare/v0.0.1-alpha...v0.0.2-alpha
1737
+
1738
+ ## [0.0.1-alpha] - 2022-03-09
1739
+
1740
+ Initial release to test Github Packages publishing