18 KiB
Changelog
Shoelace follows Semantic Versioning. Breaking changes in components with the Stable badge will not be accepted until the next major version. As such, all contributions must consider the project's roadmap and take this into consideration. Features that are deemed no longer necessary will be deprecated but not removed.
Components with the Experimental badge should not be used in production. They are made available as release candidates for development and testing purposes. As such, changes to experimental components will not be subject to semantic versioning.
During the beta period, these restrictions may be relaxed in the event of a mission-critical bug. 🐛
Next
- 🚨 BREAKING CHANGE: Refactored
sl-select
to improve accessibility #216- Removed the internal
sl-input
because it was causing problems with a11y and virtual keyboards - Removed
input
,prefix
andsuffix
parts
- Removed the internal
- 🚨 BREAKING CHANGE: Removed
copy-button
part fromsl-color-picker
since copying is now done by clicking the preview - Added
getFormattedValue()
method tosl-color-picker
so you can retrieve the current value in any format - Fixed a bug where moving the mouse while
sl-dropdown
is closing would remove focus from the trigger - Fixed a bug where
sl-menu-item
didn't set a default color in the dark theme - Fixed a bug where
sl-color-picker
preview wouldn't update in Safari - Removed
sl-blur
andsl-focus
events fromsl-menu
since menus can't have focus since 2.0.0-beta.22
2.0.0-beta.24
- Added
sl-format-date
component - Added
indeterminate
state tosl-progress-bar
#274 - Added
--track-color
,--indicator-color
, and--label-color
tosl-progress-bar
#276 - Added
allow-scripts
prop tosl-include
#280 - Fixed a bug where
sl-menu-item
color variable was incorrect #272 - Fixed a bug where
sl-dialog
andsl-drawer
would emit thesl-hide
event twice #275 - Fixed a bug where calling
event.preventDefault()
on certain form elements wouldn't preventsl-form
from submitting #277 - Fixed drag handle orientation in
sl-image-comparer
- Restyled
sl-spinner
so the track is visible and the indicator is smaller. - Removed
resize-observer-polyfill
in favor of@types/resize-observer-browser
since all target browsers supportResizeObserver
- Upgraded the status of
sl-form
,sl-image-comparer
, andsl-include
from experimental to stable
2.0.0-beta.23
- Added
sl-format-number
component - Added
sl-relative-time
component - Added
closable
prop tosl-tab
- Added experimental
sl-resize-observer
utility - Added experimental
sl-theme
utility and updated theming documentation - Fixed a bug where
sl-menu-item
wouldn't render properly in the dark theme - Fixed a bug where
sl-select
would show an autocomplete menu - Improved placeholder contrast in dark theme
- Updated to Boostrap Icons 1.1.0
- Updated to Stencil 2.3.0
2.0.0-beta.22
- 🚨 BREAKING CHANGE: Refactored
sl-menu
andsl-menu-item
to improve accessibility by using proper focus states #217- Moved
tabindex
fromsl-menu
tosl-menu-item
- Removed the
active
prop fromsl-menu-item
because synthetic focus states are bad for accessibility - Removed the
sl-activate
andsl-deactivate
events fromsl-menu-item
(listen forfocus
andblur
instead) - Updated
sl-select
so keyboard navigation still works
- Moved
- Added
no-scroll-controls
prop tosl-tab-group
#253 - Fixed a bug where setting
open
initially wouldn't showsl-dialog
orsl-drawer
#255 - Fixed a bug where
disabled
could be set when buttons are rendered as links - Fixed a bug where hoisted dropdowns would render in the wrong position when placed inside
sl-dialog
#252 - Fixed a bug where boolean aria attributes didn't explicitly set
true|false
string values in the DOM - Fixed a bug where
aria-describedby
was never set on tooltip targets insl-tooltip
- Fixed a bug where setting
position
onsl-image-comparer
wouldn't update the divider's position - Fixed a bug where the check icon was announced to screen readers in
sl-menu-item
- Improved
sl-icon-button
accessibility by encouraging proper use oflabel
and hiding the internal icon from screen readers #220 - Improved
sl-dropdown
accessibility by attachingaria-haspopup
andaria-expanded
to the slotted trigger - Refactored position logic to remove an unnecessary state variable in
sl-image-comparer
- Refactored design tokens to use
rem
instead ofpx
for input height and spacing #221 - Removed
console.log
from modal utility - Updated to Stencil 2.2.0
2.0.0-beta.21
- Added
label
slot tosl-input
,sl-select
, andsl-textarea
#248 - Added
label
slot tosl-dialog
andsl-drawer
- Added experimental
sl-include
component - Added status code to the
sl-error
event insl-icon
- Fixed a bug where initial transitions didn't show in
sl-dialog
andsl-drawer
#247 - Fixed a bug where indeterminate checkboxes would maintain the indeterminate state when toggled
- Fixed a bug where concurrent active modals (i.e. dialog, drawer) would try to steal focus from each other
- Improved
sl-color-picker
grid and slider handles #246 - Refactored
sl-icon
request logic and removed unused cache map - Reworked show/hide logic in
sl-alert
,sl-dialog
, andsl-drawer
to not use reflow hacks and thehidden
attribute - Reworked slot logic in
sl-card
,sl-dialog
, andsl-drawer
- Updated to Popper 2.5.3 to address a fixed position bug in Firefox
2.0.0-beta.20
- 🚨 BREAKING CHANGE: Transformed all Shoelace events to lowercase (details)
- Added support for dropdowns and non-icon elements to
sl-input
- Added
spellcheck
prop tosl-input
- Added
sl-icon-library
to allow custom icon library registration - Added
library
prop tosl-icon
andsl-icon-button
- Added "Integrating with Rails" tutorial to the docs, courtesy of ParamagicDev
- Fixed a bug where
sl-progress-ring
rendered incorrectly when zoomed in Safari #227 - Fixed a bug where tabbing into slotted elements closes
sl-dropdown
when used in a shadow root #223 - Fixed a bug where scroll anchoring caused undesirable scrolling when
sl-details
are grouped
Why did event names change?
Shoelace events were updated to use a lowercase, kebab-style naming convention. Instead of event names such as slChange
and slAfterShow
, you'll need to use sl-change
and sl-after-show
now.
This change was necessary to address a critical issue in frameworks that use DOM templates with declarative event bindings such as <sl-button @slChange="handler">
. Due to HTML's case-insensitivity, browsers translate attribute names to lowercase, turning @slChange
into @slchange
, making it impossible to listen to slChange
.
While declarative event binding is a non-standard feature, not supporting it would make Shoelace much harder to use in popular frameworks. To accommodate those users and provide a better developer experience, we decided to change the naming convention while Shoelace is still in beta.
The following pages demonstrate why this change was necessary.
2.0.0-beta.19
- Added
input
,label
,prefix
,clear-button
,suffix
,help-text
exported parts tosl-select
to make the input customizable - Added toast notifications through the
toast()
method onsl-alert
- Fixed a bug where mouse events would bubble up when
sl-button
was disabled, causing tooltips to erroneously appear - Fixed a bug where pressing space would open and immediately close
sl-dropdown
panels in Firefox - Fixed a bug where
sl-tooltip
would throw an error on init - Fixed a bug in custom keyframes animation example
- Refactored clear logic in
sl-input
2.0.0-beta.18
- Added
name
andinvalid
prop tosl-color-picker
- Added support for form submission and validation to
sl-color-picker
- Added touch support to demo resizers in the docs
- Added
sl-responsive-embed
component - Fixed a bug where swapping an animated element wouldn't restart the animation in
sl-animation
- Fixed a bug where the cursor was incorrect when
sl-select
was disabled - Fixed a bug where
slblur
andslfocus
were emitted twice insl-select
- Fixed a bug where clicking on
sl-menu
wouldn't focus it - Fixed a bug in the popover utility where
onAfterShow
would fire too soon - Fixed a bug where
bottom
andright
placements didn't render properly insl-tab-group
- Improved keyboard logic in
sl-dropdown
,sl-menu
, andsl-select
- Updated
sl-animation
to stable - Updated to Stencil 2.0 (you may need to purge
node_modules
and runnpm install
after pulling) - Updated entry points in
package.json
to reflect new filenames generated by Stencil 2
2.0.0-beta.17
- Added
minlength
andspellcheck
attributes tosl-textarea
- Fixed a bug where clicking a tag in
sl-select
wouldn't toggle the menu - Fixed a bug where options where
sl-select
options weren't always visible or scrollable - Fixed a bug where setting
null
onsl-input
,sl-textarea
, orsl-select
would throw an error - Fixed a bug where
role
was on the wrong element and aria attribute weren't explicit insl-checkbox
,sl-switch
, andsl-radio
- Fixed a bug where dynamically adding/removing a slot wouldn't work as expected in
sl-card
,sl-dialog
, andsl-drawer
- Fixed a bug where the value wasn't updated and events weren't emitted when using
setRangeText
insl-input
andsl-textarea
- Optimized
hasSlot
utility by using a simpler selector - Updated Bootstrap Icons to 1.0.0 with many icons redrawn and improved
- Updated contribution guidelines
Form validation has been reworked and is much more powerful now!
- The
invalid
prop now reflects the control's validity as determined by the browser's constraint validation API - Added
required
tosl-checkbox
,sl-select
, andsl-switch
- Added
reportValidity()
andsetCustomValidity()
methods to all form controls - Added validation checking for custom and native form controls to
sl-form
- Added
novalidate
prop tosl-form
to disable validation - Removed the
valid
prop from all form controls - Removed valid and invalid design tokens and related styles (you can use your own custom styles to achieve this)
2.0.0-beta.16
- Add
hoist
prop tosl-color-picker
,sl-dropdown
, andsl-select
to work around panel clipping - Add
sl-format-bytes
utility component - Add
clearable
andrequired
props tosl-select
- Add
slclear
event tosl-input
- Added keyboard support to the preview resizer in the docs
- Fixed a bug where the
aria-selected
state was incorrect insl-menu-item
- Fixed a bug where custom properties applied to
sl-tooltip
didn't affect show/hide transitions - Fixed a bug where
--sl-input-color-*
custom properties had no affect onsl-input
andsl-textarea
- Refactored
sl-dropdown
andsl-tooltip
to use positioner elements so panels/tooltips can be customized easier
2.0.0-beta.15
- Added
image-comparer
component - Added
--width
,--height
, and--thumb-size
custom props tosl-switch
- Fixed an
aria-labelledby
attribute typo in a number of components - Fixed a bug where the
change
event wasn't updating the value insl-input
- Fixed a bug where
sl-color-picker
had the wrong border color in the dark theme - Fixed a bug where
sl-menu-item
had the wrong color in dark mode when disabled - Fixed a bug where WebKit's autocomplete styles made inputs looks broken
- Fixed a bug where aria labels were wrong in
sl-select
- Fixed a bug where clicking the label wouldn't focus the control in
sl-select
2.0.0-beta.14
- Added dark theme
- Added
--sl-panel-background-color
and--sl-panel-border-color
tokens - Added
--tabs-border-color
custom property tosl-tab-group
- Added
--track-color
custom property tosl-range
- Added
tag
part tosl-select
- Updated
package.json
so custom elements imports can be consumed from the root - Fixed a bug where scrolling dialogs didn't resize properly in Safari
- Fixed a bug where
slshow
andslhide
would be emitted twice in some components - Fixed a bug where
custom-elements/index.d.ts
was broken due to an unclosed comment (fixed in Stencil 1.17.3) - Fixed bug where inputs were not using border radius tokens
- Fixed a bug where the text color was being erroneously set in
sl-progress-ring
- Fixed a bug where
sl-progress-bar
used the wrong part name internally forindicator
- Removed background color from
sl-menu
- Updated to Stencil 1.17.3
2.0.0-beta.13
- Added
slactivate
andsldeactivate
events tosl-menu-item
- Added experimental
sl-animation
component - Added shields to documentation
- Fixed a bug where link buttons would have
type="button"
- Fixed a bug where button groups with tooltips experienced an odd spacing issue in Safari
- Fixed a bug where scrolling in dropdowns/selects didn't work properly on Windows (special thanks to Trendy for helping troubleshoot!)
- Fixed a bug where selecting a menu item in a dropdown would cause Safari to scroll
- Fixed a bug where type to select wouldn't accept symbols
- Moved scrolling logic from
sl-menu
tosl-dropdown
2.0.0-beta.12
- Added support for
href
,target
, anddownload
to buttons - Fixed a bug where buttons would have horizontal spacing in Safari
- Fixed a bug that caused an import resolution error when using Shoelace in a Stencil app
2.0.0-beta.11
- Added button group component
- Fixed icon button alignment
- Fixed a bug where focus visible observer wasn't removed from
sl-details
- Replaced the deprecated
componentDidUnload
lifecycle method withdisconnectedCallback
to prevent issues with frameworks
2.0.0-beta.10
- Added community page to the docs
- Fixed a bug where many components would erroneously receive an
id
when using the custom elements bundle - Fixed a bug where tab groups weren't scrollable with the mouse
2.0.0-beta.9
- Added the icon button component
- Added the skeleton component
- Added the
typeToSelect
method to menu so type-to-select behavior can be controlled externally - Added the
pulse
prop to badge - Fixed a bug where hovering over select showed the wrong cursor
- Fixed a bug where tabbing into a select control would highlight the label
- Fixed a bug where tabbing out of a select control wouldn't close it
- Fixed a bug where closing dropdowns wouldn't give focus back to the trigger
- Fixed a bug where type-to-select wasn't working after the first letter
- Fixed a bug where clicking on menu items and dividers would steal focus from the menu
- Fix a bug where the color picker wouldn't parse uppercase values
- Removed
noFooter
prop from dialog and drawer (slot detection is automatic, so the prop is not required) - Removed
close-icon
slot from alert - Replaced make-shift icon buttons with
sl-icon-button
in alert, dialog, drawer, and tag - Updated Stencil to 1.17.1
- Switched to jsDelivr for better CDN performance
2.0.0-beta.8
- Added the card component
- Added
--focus-ring
custom property to tab - Fixed a bug where range tooltips didn't appear on iOS
- Fixed constructor bindings so they don't break the custom elements bundle
- Fixed tag color contrast to be AA compliant
- Fixed a bug that made it difficult to vertically align rating
- Fixed a bug where dropdowns would always close on mousedown when inside a shadow root
- Made tag text colors AA compliant
- Promoted badge to stable
- Refactored
:host
variables and moved non-display props to base elements - Refactored event handler bindings to occur in
connectedCallback
instead of the constructor - Refactored scroll locking logic to use
Set
instead of an array - Updated the custom elements bundle documentation and added bundler examples
- Upgraded Stencil to 1.17.0-0 (next) to fix custom elements bundle
2.0.0-beta.7
- Added links to version 1 resources to the docs
- Added rating component
- Fixed a bug where some build files were missing
- Fixed clearable tags demo
- Fixed touch icon size in docs
2.0.0-beta.6
- Enabled the
dist-custom-elements-bundle
output target - Fixed a bug where nested form controls were ignored in
<sl-form>
2.0.0-beta.5
- Fixed bug where
npm install
would fail due to postinstall script - Removed unused dependency
2.0.0-beta.4
- Added
pill
variation to badges - Fixed a bug where all badges had
pointer-events: none
- Fixed
@since
props to show 2.0 instead of 1.0 - Fixed giant cursors in inputs in Safari
- Fixed color picker input width in Safari
- Fixed initial transitions for drawer, dialog, and popover consumers
- Fixed a bug where dialog, dropdown, and drawer would sometimes not transition in on the first open
- Fixed various documentation typos
2.0.0-beta.3
- Fix version in docs
- Remove custom elements bundle
2.0.0-beta.2
- Fix quick start and installation URLs
- Switch Docsify theme
- Update line heights tokens
2.0.0-beta.1
- Initial release