@rolemodel/optics 2.4.0 → 2.5.1

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