Ir al contenido

Release Notes

Esta página aún no está disponible en tu idioma.

This document contains release notes for the @studiocms/ui package. For more information, see the CHANGELOG file ⤴

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Moves the following helpers into their own virtual modules:

    • studiocms:ui/components/toaster/client - toast
    • studiocms:ui/components/modal/client - ModalHelper
    • studiocms:ui/components/dropdown/client - DropdownHelper
    • studiocms:ui/components/progress/client - ProgressHelper
    • studiocms:ui/components/sidebar/client - SingleSidebarHelper, DoubleSidebarHelper

    There is also a new studiocms:ui/components/client joined module that contains all the above component helpers.

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Update Icon component to utilize all iconifyJSON icons that have been passed through into the config

    • Default Icon names are now prefixed with heroicons: instead of just the icons name. This allows user-defined icons to be used without conflicting with the pre-shipped icons.
  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Colors have been adjusted to look better for all components. Badge variants now default to “outlined” and the “default” value has been deprecated. The deprecation was due to the badges failing WGAG AAA guidelines. All projects using the “default” variant should be updated to use “outlined” instead.

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Introduce individual component virtual exports alongside the bundled barrel virtual export 'studiocms:ui/components'

    You can now import for example Button component from studiocms:ui/components/button

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Updates the Tabs components to optionally use a custom ID

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Migrate from injected types to ambient types for static virtual modules

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Adds a skeleton loading state component

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Removes ThemeToggle as it was causing a error when added to the virtual module, it is now recommended to use the ThemeHelper directly

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Refactors the select components into web components

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Changes the inputs icon color to var(—text-muted)

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes #91, alert type is respected and shows appropriate colors

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes the focus outline of buttons within groups sometimes being hidden behind other buttons in the same group.

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes toggle colors, adds new “gray” color for toggle circles, and adds a light variant for the default flat colors.

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes Select components UI bug, where list items had no background and showed bullet points

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - - Refactored the accordion component so it works with the Tabs component, and with nested accordions

    • Refactored the Tabs component to support nested tabs
    • Added a new active prop to the Tabs component to set the initial active tab
  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes an issue where the toaster HTML Element would have an unnecessary comma attribute due to a typo.

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Changes the way colors are declared to allow for a better customization experience.

    Before, we would use raw HSL values in order to be able to modify them later on:

    :root {
    --background-base: 0 0% 6%;
    }

    This introduces an unnecessary hurdle to customization, since most other libraries ship with either their own color values and spaces or a different approach entirely. Thus, the goal of this PR is to replace this approach with a simpler one. We will now default to HSL functions instead of the raw values:

    :root {
    --background-base: hsl(0 0% 6%);
    }

    Migrating from this can be a little tedious if the old system was used in custom components. You can use this regular expression with VSCode’s (or any other IDE’s) search & replace feature to replace all instances of the old syntax with the new:

    Search Value: hsl[a]?\((var\([A-Za-z-\d]+\))\) Replace Value: $1

    Please make sure to manually search for hsl(var( and hsla(var( after running the above to make sure all previous values have been replaced.

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes buttons within dropdowns not displaying properly within a group

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - adds the tooltip component

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Adds optional icons and help texts to inputs

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Improve icon handling and processing, allowing icon sets defined in the config to also use - in their name (e.g. ‘simple-icons’)

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixed undeclared css variables for flat button style

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Fixes ambient type declarations

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Adds StudioCMS Typography using a .prose class

  • #85 ⤴ a7e37a5 ⤴ Thanks @louisescher ⤴! - Adds a missing background color to modals

  • #137 ⤴ dee51eb ⤴ Thanks @Adammatthiesen ⤴! - Moves the following helpers into their own virtual modules:

    • studiocms:ui/components/toaster/client - toast
    • studiocms:ui/components/modal/client - ModalHelper
    • studiocms:ui/components/dropdown/client - DropdownHelper
    • studiocms:ui/components/progress/client - ProgressHelper
    • studiocms:ui/components/sidebar/client - SingleSidebarHelper, DoubleSidebarHelper

    There is also a new studiocms:ui/components/client joined module that contains all the above component helpers.

  • #133 ⤴ 8e2172d ⤴ Thanks @RATIU5 ⤴! - Fixed undeclared css variables for flat button style

  • #130 ⤴ 57f900d ⤴ Thanks @RATIU5 ⤴! - Fixes toggle colors, adds new “gray” color for toggle circles, and adds a light variant for the default flat colors.
  • #125 ⤴ 9473be8 ⤴ Thanks @RATIU5 ⤴! - Colors have been adjusted to look better for all components. Badge variants now default to “outlined” and the “default” value has been deprecated. The deprecation was due to the badges failing WGAG AAA guidelines. All projects using the “default” variant should be updated to use “outlined” instead.

  • #118 ⤴ 1779190 ⤴ Thanks @RATIU5 ⤴! - Updates the Tabs components to optionally use a custom ID

  • #119 ⤴ 6bdc0ee ⤴ Thanks @louisescher ⤴! - Fixes an issue where the toaster HTML Element would have an unnecessary comma attribute due to a typo.

  • #124 ⤴ 8a2f606 ⤴ Thanks @Adammatthiesen ⤴! - Improve icon handling and processing, allowing icon sets defined in the config to also use - in their name (e.g. ‘simple-icons’)

  • #88 ⤴ b96fe4d ⤴ Thanks @Adammatthiesen ⤴! - Update Icon component to utilize all iconifyJSON icons that have been passed through into the config

    • Default Icon names are now prefixed with heroicons: instead of just the icons name. This allows user-defined icons to be used without conflicting with the pre-shipped icons.
  • #106 ⤴ 613830e ⤴ Thanks @Adammatthiesen ⤴! - Introduce individual component virtual exports alongside the bundled barrel virtual export 'studiocms:ui/components'

    You can now import for example Button component from studiocms:ui/components/button

  • #89 ⤴ ce1f6fc ⤴ Thanks @Adammatthiesen ⤴! - Migrate from injected types to ambient types for static virtual modules

  • #86 ⤴ 63e3b9e ⤴ Thanks @RATIU5 ⤴! - Adds a skeleton loading state component

  • #87 ⤴ 80d1970 ⤴ Thanks @Adammatthiesen ⤴! - Removes ThemeToggle as it was causing a error when added to the virtual module, it is now recommended to use the ThemeHelper directly

  • #92 ⤴ bd47caf ⤴ Thanks @RATIU5 ⤴! - Fixes #91, alert type is respected and shows appropriate colors

  • #103 ⤴ 111e685 ⤴ Thanks @RATIU5 ⤴! - Fixes Select components UI bug, where list items had no background and showed bullet points

  • #104 ⤴ f708d9d ⤴ Thanks @RATIU5 ⤴! - - Refactored the accordion component so it works with the Tabs component, and with nested accordions

    • Refactored the Tabs component to support nested tabs
    • Added a new active prop to the Tabs component to set the initial active tab
  • #96 ⤴ ddf67da ⤴ Thanks @louisescher ⤴! - Changes the way colors are declared to allow for a better customization experience.

    Before, we would use raw HSL values in order to be able to modify them later on:

    :root {
    --background-base: 0 0% 6%;
    }

    This introduces an unnecessary hurdle to customization, since most other libraries ship with either their own color values and spaces or a different approach entirely. Thus, the goal of this PR is to replace this approach with a simpler one. We will now default to HSL functions instead of the raw values:

    :root {
    --background-base: hsl(0 0% 6%);
    }

    Migrating from this can be a little tedious if the old system was used in custom components. You can use this regular expression with VSCode’s (or any other IDE’s) search & replace feature to replace all instances of the old syntax with the new:

    Search Value: hsl[a]?\((var\([A-Za-z-\d]+\))\) Replace Value: $1

    Please make sure to manually search for hsl(var( and hsla(var( after running the above to make sure all previous values have been replaced.

  • #101 ⤴ 12eba39 ⤴ Thanks @RATIU5 ⤴! - adds the tooltip component

  • #93 ⤴ bb5ab5a ⤴ Thanks @RATIU5 ⤴! - Adds StudioCMS Typography using a .prose class

  • #94 ⤴ 2b89d92 ⤴ Thanks @RATIU5 ⤴! - prevents overflow select dropdowns with a scrollable container and enables toggling the dropdown via svg icon click
  • #56 ⤴ 40ae2ea ⤴ Thanks @Adammatthiesen ⤴! - Add option to disable global CSS injection and allow users to import the global css themselves.

    Basic Example of how to import:

    ---
    import "studiocms:ui/global-css";
    ---
  • #48 ⤴ 4a43e03 ⤴ Thanks @Adammatthiesen ⤴! - Fix Icon component requiring functions from Iconify Utils lib during runtime as well as extend usage possibilities.

    NEW:

    • IconBase component exported from studiocms:ui/components which allows passing custom image collections from Iconify.

    Updated:

    • Icon component to use this new system.
  • #36 ⤴ 07e2d9e ⤴ Thanks @louisescher ⤴! - Implement Build step and migrate all exported components into virtual modules

    Instead of @studiocms/ui/components use studiocms:ui/components

    For more information see https://ui.studiocms.dev ⤴

  • #36 ⤴ 07e2d9e ⤴ Thanks @louisescher ⤴! - Add a few new components:

    • Accordion
    • Badge
    • Breadcrumbs
    • Group
    • Progress
    • Sidebar

    Add two new colors

    • info (Blue)
    • monochrome (Black/White)

    Add the ability to pass a CSS file for customization of all colors

  • #18 ⤴ e471e11 ⤴ Thanks @louisescher ⤴! - The Accessibility Update

    This version of @studiocms/ui includes a lot of improvements to the documentation and components. The most important changes include the move to an integration-based system and a massive keyboard accessibility overhaul (thanks to HiDeoo ⤴ for the feedback on this)!

    • Added a new <Tabs /> component based on the tabs on the homepage.
    • Updated the <Card /> component to include a new “filled” style.
    • Moved the ThemeHelper class to its own category in the docs.
    • Overhauled the keyboard accessibility on all components to make them adhere to the ARIA standards.
  • Initial Testing release