diff --git a/CHANGELOG.md b/CHANGELOG.md index 8224b9e..8542bad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,31 @@ # Changelog +## Unreleased + +- Added support for bitstyles `v5.0.0`. You can continue using bitstyles_phoenix with a lower bitstyles version, or migrate your codebase to bitstyles `v5.0.0`. + +### How to migrate to bitstyles `v5.0.0` + +Follow the [bitstyles changelog](https://github.com/bitcrowd/bitstyles/blob/main/CHANGELOG.md#500---2023-01-03) for versions 5.0.0 and 5.0.0-alpha-1. Even if you're using the `BitstylesPhoenix.Helper.Classnames.classnames/1` helper to apply bitstyles classes in your own codebase, you will still need to migrate some of them yourself. For example, the class `u-gap-m` could not have been migrated via the helper because it exists in both bitstyles versions with different meanings (`u-gap-m` and `u-gap-l` in bitstyles 4.3.0 are equivalent to `u-gap-l` and `u-gap-xl` in bitstyles `v5.0.0`). + +The `variant` attribute of the `Button` component is deprecated in bitstyles `v5.0.0`. Use the attributes `shape` and `color` instead. + ## v2.3.1 - 2023-10-23 -- Bump LiveView + +- Bump LiveView. ## v2.3.0 - 2023-05-15 -- Add `Modal` component + +- Add `Modal` component. ## v2.2.0 - 2023-03-20 -- Updated to LiveView 0.18.18 -- Add `Card` and `Avatar` components +- Updated to LiveView 0.18.18. +- Add `Card` and `Avatar` components. ## v2.1.1 - 2022-12-02 -- Fixed version backwards compatibility +- Fixed version backwards compatibility. ## v2.1.0 - 2022-12-02 @@ -60,7 +72,7 @@ the support for the `ui_button` as helper is dropped completely in favor of comp ## v1.0.0 - 2022-01-04 -This version breaks with the existing API quite a lot 🔥, since we changed the library to take advantage of the recent develpments in Phoenix and LiveView. +This version breaks with the existing API quite a lot 🔥, since we changed the library to take advantage of the recent developments in Phoenix and LiveView. ### Breaking diff --git a/README.md b/README.md index bc512f8..df03eae 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Basic helpers for [bitstyles](https://github.com/bitcrowd/bitstyles) for elixir Bitstyles must be installed separately into the asset generation. The helpers in this project just output classes for working with bitstyles. -Bitstyles versions from 4.3.0 down to 1.3.0 are supported. +Bitstyles versions from 5.0.1 down to 1.3.0 are supported. ## Installation diff --git a/lib/bitstyles_phoenix.ex b/lib/bitstyles_phoenix.ex index 1f24932..ea62c15 100644 --- a/lib/bitstyles_phoenix.ex +++ b/lib/bitstyles_phoenix.ex @@ -22,7 +22,7 @@ defmodule BitstylesPhoenix do ```elixir <.ui_badge>A nice badge - # => A nice badge + # => A nice badge ``` ```elixir diff --git a/lib/bitstyles_phoenix/alpine3/dropdown.ex b/lib/bitstyles_phoenix/alpine3/dropdown.ex index 5e8ac50..553fa7f 100644 --- a/lib/bitstyles_phoenix/alpine3/dropdown.ex +++ b/lib/bitstyles_phoenix/alpine3/dropdown.ex @@ -47,7 +47,7 @@ defmodule BitstylesPhoenix.Alpine3.Dropdown do ''' """
- -