Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add codemod for Text component interface #1849

Merged
merged 11 commits into from
Dec 22, 2023

Conversation

yangwooseong
Copy link
Collaborator

@yangwooseong yangwooseong commented Dec 20, 2023

Self Checklist

  • I wrote a PR title in English and added an appropriate label to the PR.
  • I wrote the commit message in English and to follow the Conventional Commits specification.
  • I added the changeset about the changes that needed to be released. (or didn't have to)
  • I wrote or updated documentation related to the changes. (or didn't have to)
  • I wrote or updated tests related to the changes. (or didn't have to)
  • I tested the changes in various browsers. (or didn't have to)
    • Windows: Chrome, Edge, (Optional) Firefox
    • macOS: Chrome, Edge, Safari, (Optional) Firefox

Related Issue

Summary

// As-is
import { Text, Typography } from '@channel.io/bezier-react'

<Text 
  typo={Typography.Size14}
  marginHorizontal={6}
>
  some text
</Text>

// To-be
import { Text } from '@channel.io/bezier-react'

<Text 
  typo="14"
  mx={6}
>
  some text
</Text>

// As-is
import { Text, styled, Typography } from '@channel.io/bezier-react'

const Title = styled(Text).attrs({
  typo: Typography.Size11,
  marginHorizontal: 6,
})``

// To-be
import { Text, styled } from '@channel.io/bezier-react'

const Title = styled(Text).attrs({
  typo: '11',
  mxl: 6,
})``

Details

  • 컴포넌트의 prop 을 변경하는 유틸과 styled component 안에서 .attrs 뒤에 나오는 객체를 변경하는 유틸을 추가했습니다.

Breaking change? (Yes/No)

  • No

References

@yangwooseong yangwooseong added the bezier-codemod Issue or PR related to bezier-codemod label Dec 20, 2023
@yangwooseong yangwooseong self-assigned this Dec 20, 2023
Copy link

changeset-bot bot commented Dec 20, 2023

🦋 Changeset detected

Latest commit: 356134e

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@channel.io/bezier-codemod Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@yangwooseong yangwooseong marked this pull request as draft December 20, 2023 10:12
Copy link

codecov bot commented Dec 20, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f33060f) 86.37% compared to head (356134e) 86.37%.

Additional details and impacted files
@@           Coverage Diff           @@
##            alpha    #1849   +/-   ##
=======================================
  Coverage   86.37%   86.37%           
=======================================
  Files         275      275           
  Lines        3765     3765           
  Branches      795      795           
=======================================
  Hits         3252     3252           
  Misses        434      434           
  Partials       79       79           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

node.getFirstChild()?.replaceWithText(to)
}

export const transformAttrProperty = (sourceFile: SourceFile, transformMap: Record<string, Record<string, string>>) => {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


const MARGIN_TRANSFORM_MAP = {
const MARGIN_TRANSFORM_MAP: ComponentTransformMap = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

STYLED_ATTRS_TRANSFORM_MAP 같은 이름이 적합하지 않을까요? transform 구현이 바뀌면서 map에 typography도 추가되었으니까요

Size24: '24',
Size30: '30',
Size36: '36',
const TYPOGRAPHY_MAP: ComponentTransformMap = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

마찬가지로 JSX_TRANSFORM_MAP ?

@@ -291,7 +291,7 @@ function Bar() {

`v2-text-component-interface`

Replace `Typography` enum with string literal and change properties related to margin to be shorthand. **Notice that this transforms all `Typography` enum in styled component, so `v2-typography-interpolation-to-css-variable` should be applied first.**
Replace `Typography` enum with string literal and change properties related to margin to be shorthand.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

뒤 문구는 왜 제거된건지 궁금합니다!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

transformEnumMemberToStringLiteral 를 사용하게 되면, Typography enum 을 모두 바꿔버립니다.

// As-is
import { styled, Text, Typogarphy } from '@channel.io/bezier-react'

const Title = styled(Text).attrs({
  typo: Typography.Size11,
})``

const Subtitle = styled(Text)`
  ${Typography.Size11}
`  

// To-be
import { styled, Text } from '@channel.io/bezier-react'

const Title = styled(Text).attrs({
  typo: '11',
})``

const Subtitle = styled(Text)`
  '11',
`  

그렇기 때문에 changeAttrProperty 함수로 바꾸었고, 이제 이런 케이스를 잘 핸들링할 수 있게 되어서 위 문구를 제거했습니다. ba57985 에서 관련 테스트 케이스를 추가했습니다.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

아 바로 이해됐습니다ㅎㅎ 감사합니다

@sungik-choi
Copy link
Contributor

리베이스 한 번 부탁드릴게요

},
})
interpolationTransform(sourceFile, CSS_VARIABLE_TRANSFORM_MAP)
transformEnumTostringLiteralInBezier(sourceFile, ENUM_TRANSFORM_MAP)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
transformEnumTostringLiteralInBezier(sourceFile, ENUM_TRANSFORM_MAP)
transformEnumToStringLiteralInBezier(sourceFile, ENUM_TRANSFORM_MAP)

마이너: typo. 지금 봤네요

@yangwooseong yangwooseong merged commit 7cb0f2e into channel-io:alpha Dec 22, 2023
10 checks passed
@yangwooseong yangwooseong deleted the feat/codemod-for-text branch December 22, 2023 06:53
sungik-choi pushed a commit that referenced this pull request Dec 22, 2023
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to alpha, this PR
will be updated.

⚠️⚠️⚠️⚠️⚠️⚠️

`alpha` is currently in **pre mode** so this branch has prereleases
rather than normal releases. If you want to exit prereleases, run
`changeset pre exit` on `alpha`.

⚠️⚠️⚠️⚠️⚠️⚠️

# Releases
## @channel.io/bezier-react@2.0.0-alpha.4

### Major Changes

- `typo` prop of `Text` component is changed to a string literal. Please
migrate it like below. With the removal of the styled-component from
bezier-react, CSS interpolation is no longer available.
([#1820](#1820)) by
@sungik-choi

    ```tsx
    /* AS-IS */
    <Text typo={Typography.Size11} />
    <Text typo={Typography.Size12} />
    <Text typo={Typography.Size13} />
    <Text typo={Typography.Size14} />
    <Text typo={Typography.Size15} />
    <Text typo={Typography.Size16} />
    <Text typo={Typography.Size17} />
    <Text typo={Typography.Size18} />
    <Text typo={Typography.Size22} />
    <Text typo={Typography.Size24} />
    <Text typo={Typography.Size30} />
    <Text typo={Typography.Size36} />

    /* TO-BE */
    <Text typo="11" />
    <Text typo="12" />
    <Text typo="13" />
    <Text typo="14" />
    <Text typo="15" />
    <Text typo="16" />
    <Text typo="17" />
    <Text typo="18" />
    <Text typo="22" />
    <Text typo="24" />
    <Text typo="30" />
    <Text typo="36" />
    ```

- `AlphaStack` component has been changed to a `Stack` component, and
`Stack` component has been changed to `LegacyStack` component. Changes
to remove the dependency of `Stack` and `StackItem` to allow stack
layouts to be configured without additional DOM elements. And improved
the existing `AlphaStack` to support more Flex layout related properties
like reverse, wrap, and more align options, etc. See StackProps for more
information.
([#1837](#1837)) by
@sungik-choi

We also added new `HStack` and `VStack` components, which are shorthand
components that fix the direction prop of `AlphaStack`. As mentioned
above, the existing components become `LegacyHStack`, `LegacyVStack`.

The layout implemented by `StackItem` can be partially replaced by the
Layout component's `grow`, `shrink` common properties and margin common
properties. Note that the `align`, `justify` (align-self, justify-self
in CSS flex) properties provided by `StackItem` are not provided by the
Layout component.

    ```jsx
    /* AS-IS */
    return (
      <Stack
        direction="horizontal"
        spacing={8}
        style={{ width: 300, height: 50 }}
      >
        <StackItem grow shrink weight={1} />
        <StackItem weight={0} size={10} marginBefore={20}>
          <Stack direction="vertical" />
        </StackItem>
      </Stack>
    );

    /* TO-BE */
    return (
      <Stack direction="horizontal" spacing={8} width={300} height={50}>
        <Box grow={1} shrink={1} />
        <Stack direction="vertical" shrink={0} width={10} ml={12} />
      </Stack>
    );
    ```

The changes also apply to other components that use `Stack` internally,
and there are a few changes.

    -   `RadioGroup` component no longer supports `as` prop.
- `ButtonGroup` component now extends the interfaces of new `Stack`. It
no longer supports `as` prop.
- `FormGroup` component now extends the interfaces of new `Stack`. It no
longer supports `as` prop.

### Minor Changes

- Fixes style inheritance issues by explicitly giving CSS custom
properties an initial value.
([#1846](#1846)) by
@sungik-choi

- Add `align` prop to `Text` component. This prop is used to set
horizontal alignment of text.
([#1820](#1820)) by
@sungik-choi

    ```tsx
    <Text align="left" />
    <Text align="center" />
    <Text align="right" />
    ```

- Remove `borderStyle` prop from Layout props.
([#1848](#1848)) by
@sungik-choi

## @channel.io/bezier-codemod@0.5.0-alpha.2

### Minor Changes

- Add codemod for Stack component
([#1836](#1836)) by
@yangwooseong

- Add codemod to transform interface of `Text` component
([#1849](#1849)) by
@yangwooseong

- Enhance `import-styled-from-styled-component` codemod to cover other
APIs from `styled-components`
([#1852](#1852)) by
@yangwooseong

- Add Typography transform logic to interpolation codemod
([#1841](#1841)) by
@yangwooseong

- Add v2 prefix to codemods related to major version 2
([#1844](#1844)) by
@yangwooseong

- Add codemod for z-index interpolation and enum
([#1845](#1845)) by
@yangwooseong

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
sungik-choi pushed a commit that referenced this pull request Mar 26, 2024
This PR was opened by the [Changesets
release](https://github.com/changesets/action) GitHub action. When
you're ready to do a release, you can merge this and the packages will
be published to npm automatically. If you're not ready to do a release
yet, that's fine, whenever you add more changesets to main, this PR will
be updated.


# Releases
## @channel.io/bezier-react@2.0.0

### Major Changes

- **Breaking Changes: Property updates in `Avatar` component**
([#1871](#1871)) by
@yangwooseong

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking changes: Remove TagBadge-related types**
([#2114](#2114)) by
@sungik-choi

    -   Remove `color` prop of `TagProps` and `TagBadgeBgColorPreset`.
- Remove `TagBadgeSize`. Please change it to `TagSize` and `BadgeSize`.
- Remove `TagBadgeVariant`. Please change it to `TagVariant` and
`BadgeVariant`.

- **Breaking Changes: Property updates in `SegmentedControl` component**
([#1866](#1866)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `ListItem` component**
([#1925](#1925)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `iconStyle`, `iconClassName`, `iconInterpolation`,
`contentStyle`, `contentClassName` and `contentInterpolation`. This
decision was made to reduce excessive flexibility in the interface.
- No longer support `leftIcon` property. Removed for consistency with
other component interfaces. Replace it to `leftContent`.
- No longer support `name` property. The second argument (name) of
`onClick` is also removed. If you need an identifier, combine functions
outside of the component.
- No longer support `hide`, `nested`, `optionKey` and
`disableIconActive` property. Removed because it is a legacy property.
Replace `hide` property with conditional rendering.
- The size changes according to the `ListItemSize`. This is a change to
unify the design. Please change it like below.
        -   `ListItemSize.S` -> `ListItemSize.XS`
        -   `ListItemSize.M` -> `ListItemSize.S`
        -   `ListItemSize.L` -> `ListItemSize.M`
        -   `ListItemSize.XL` -> `ListItemSize.L`

    **Minor Changes:**

    -   Fix incorrect text size for `XL`(now `L`) size.

- **Breaking Changes: Property updates in `Overlay` component**
([#1949](#1949)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `containerInterpolation` property. Replace any usage
of `containerInterpolation` property with appropriate `containerStyle`
or `containerClassName` implementations.
    -   No longer support `wrapperTestId` property.

- **Breaking Changes: Remove `TooltipProvider` and Property updates in
`Tooltip` component**
([#1974](#1974)) by
@sungik-choi

- No longer support `TooltipProvider` and `TooltipProviderProps`.
`Tooltip` component was implemented via radix-ui's Tooltip, which
required the use of a `TooltipProvider`, which caused all subcomponents
to be re-rendered and caused a performance hit. We decided that the
ability to share hover delay time between `Tooltip` components via
`TooltipProvider` was not a feature we needed, even with the performance
penalty. Also, by providing `TooltipProvider` built-in to `AppProvider`,
we were unnecessarily importing modules from our library usage that
didn't require `Tooltip`.
    -   `Tooltip` component now contains a `TooltipProvider` inside it.

    **Minor Changes:**

    -   Change the default value of `delayShow` prop from `300` to `0`.

- **Breaking Changes: Property updates in `Tag` and `Badge` component**
([#1872](#1872)) by
@yangwooseong

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `CheckableAvatar` component**
([#1921](#1921)) by
@sungik-choi

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: `AlphaSmoothCornersBox` component is now
`SmoothCornersBox` component.**
([#2079](#2079)) by
@sungik-choi

- **Breaking Changes: Property updates in `LegacyTooltip` component**
([#1945](#1945)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `contentInterpolation` property. Replace any usage
of `contentInterpolation` property with appropriate `contentStyle` or
`contentClassName` implementations.
- No longer support `contentWrapperInterpolation` property. Replace any
usage of `contentWrapperInterpolation` property with appropriate
`contentWrapperStyle` or `contentWrapperClassName` implementations.

- **Breaking Changes: `AlphaCenter` component is now `Center` component.
Property updates in `Center` component**
([#1854](#1854)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
    -   Now supports margin props, layout props and `display` prop.

- **Breaking Changes: Property updates in `FormLabel`, `FormHelperText`,
and `FormErrorMessage` component**
([#1893](#1893)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `NavGroup` and `NavItem`
component**
([#1931](#1931)) by
@sungik-choi

`leftIcon` renamed to `leftContent`. Changed to improve consistency of
interface property names across libraries.

- **Breaking Changes: The enum type that the component receives as props
is changed to a string (or number) literal type**
([#2059](#2059)) by
@yangwooseong

    The properties that change are:

    -   `AvatarGroupEllipsisType`
    -   `IconSize`
    -   `LegacyTooltipPosition`
    -   `ModalTitleSize`
    -   `OverlayPosition`
    -   `ProgressBarSize`, `ProgressBarVariant`
    -   `SpinnerSize`
    -   `SwitchSize`
    -   `TagBadgeSize`, `TagBadgeVariant`
    -   `TextAreaHeight`
    -   `TextFieldSize`, `TextFieldVariant`
    -   `ToastPlacement`, `ToastAppearance`, `ToastPreset`
    -   `TooltipPosition`

Also, `SpinnerThickness` props of `Spinner` is not supported any more.

When changed to string literal type, it is changed to the kebab-cased
value of enum. e.g. `TooltipPosition.TopCenter` -> `top-center`. Among
the above enums, `TextAreaHeight` is converted to number literal type.
e.g. `TextAreaHeight.Row16` -> `16`, and `IconSize.normal` is converted
to `m` for consistency

- **Breaking Changes: Property updates in `FormControl`, `Select`, and
`TextField` component**
([#1948](#1948)) by
@yangwooseong

- `FormControl` component no longer supports `leftLabelWrapperHeight`
props.
- `FormControl` component now supports `size` props, which is passed as
context to the child component such as `TextField` and `Select` and
specified as the size property.
- The size property of `Select` and `TextField` component changes from
enum to string literal union type. Also, `SelectSize` and
`TextFieldSize` enum are deprecated.

- **Breaking changes: Remove `testId` and related properties**
([#1971](#1971)) by
@sungik-choi

No longer supports `testId` and related properties(e.g.
`wrapperTestId`). `testId` is a property used internally by the library
for testing with testing-library (`getByTestId`). We don't see a need to
expose this as a public API, so we remove it.

If you were using it, please replace it with the `data-testid` property.
See <https://testing-library.com/docs/queries/bytestid/>.

- **Breaking Changes: Property updates in `FormControl` component**
([#1935](#1935)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Select` component**
([#1913](#1913)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `dropdownInterpolation` property. Replace any usage
of `dropdownInterpolation` property with appropriate `dropdownStyle` or
`dropdownClassName` implementations.
- The type of `zIndex` property is changed to a z-index token. (e.g.
`"modal"`)

- **Breaking Changes: Reorganizing `SectionLabel` component**
([#1936](#1936)) by
@sungik-choi

`SectionLabel` is a complex component that can be used both in the form
of an accordion and as a simple heading. To better meet the needs of
both, we've changed the internal implementation of the component.

We've also made changes to make styling overrides as predictable as they
are for other components. The style override property, which was
unnecessarily open, is now removed.

- Remove the internal div wrapper. `style`, `className` properties are
now injected into the component instead of the old `wrapperStyle`,
`wrapperClassName`.
- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support additional style properties of `wrapper`,
`contentWrapper`, `leftWrapper` and `rightWrapper`.
- No longer support `divider` property. Replace it by adding `Divider`
component to the component's before.
- The side content property is changed. It is no longer possible to
override `iconColor`.
- When injecting `onClick` handler, the root element now behaves as a
`button` element. This change is to better support keyboard focus
control.

- **Breaking Changes: Property updates in `Emoji` component**
([#1881](#1881)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Radio` component**
([#1923](#1923)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Deprecated modules for internal use**
([#1963](#1963)) by
@sungik-choi

    -   No longer provides `useEventHandler` and `useMergeRefs` hook.
- No longer provides `useId` hook. Use `useId` hook of `react` instead.
- No longer provides `getRootElement` hook. Use `useWindow` hook
instead.
    -   No longer provides `StyleUtils` and `StringUtils` utils.

- **Breaking Changes: Property updates in `ProgressBar` component**
([#1947](#1947)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `activeStyle`, `activeClassName` and
`activeInterpolation` property.
    -   No longer support `activeTestId` property.

- **Breaking Changes: Property updates in `Tabs`-related components**
([#1960](#1960)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Text` component**
([#1820](#1820)) by
@sungik-choi

`typo` prop in the `Text` component has been changed to accept only
string literals in order to simplify the API and improve the
predictability of text styling, particularly in the context of the
removal of `styled-components` from `bezier-react`, which has led to the
unavailability of CSS Interpolation.

    **Migration Instructions:**

Use
[`v2-text-component-interface`](https://github.com/channel-io/bezier-react/tree/alpha/packages/bezier-codemod#change-interface-of-text)
transformer from `bezier-codemod` for automated migration.

- **Breaking Changes: Reorganizing `KeyValueListItem` component**
([#1941](#1941)) by
@sungik-choi

    -   **Renamed to `KeyValueItem`.**
- - No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `valueWrapperStyle`, `valueWrapperClassName`,
`valueWrapperInterpolation`, `keyWrapperStyle`, `keyWrapperClassName`
and `keyWrapperInterpolation`. This decision was made to reduce
excessive flexibility in the interface.
- No longer support `AdditionalColorProps` and `show` property of
ItemAction.
- The icon inside ItemAction is now implemented through `Button`
component.
- The Value Container will now always have 100% of the parent's width.

- Add new margin properties to `Icon` component
([#1863](#1863)) by
@yangwooseong

    -   `margin`
    -   `marginHorizontal`
    -   `marginVertical`

- **Breaking Changes: Property updates in `NavItem` and `NavGroup`
component**
([#1905](#1905)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: The enum type that the component receives as props
is changed to a string literal type**
([#2059](#2059)) by
@yangwooseong

    The properties that change are:

    -   `AvatarSize`
    -   `BannerVariant`
    -   `ButtonColorVariant`, `ButtonStyleVariant`, `ButtonSize`
    -   `EmojiSize`
    -   `SegmentedControlSize`
    -   `TabSize`
    -   `ListItemVariant`, `ListItemSize`
    -   `StatusType`, `StatusSize`

When changed to string literal type, it is changed to the kebab-cased
value of enum. e.g. `ButtonStyleVariant.MonoChromeDark` ->
`monochrome-dark`, `StatusType.OnlineCrescent` -> `online-crescent`

- **Breaking Changes: Property updates in `Modal`-related components**
([#1903](#1903)) by
@sungik-choi

    -   No longer supports `as` and `interpolation` props.
- The type of `zIndex` property is changed to a z-index token. (e.g.
`"modal"`)

- **Breaking Change: Removal of `LegacySegmentedControl` Component**
([#1786](#1786)) by
@sungik-choi

We have removed the `LegacySegmentedControl` component from our library.
This change follows its deprecation in `next-v1.204`.

    **Reasons for Removal:**

    -   To enhance web accessibility and improve keyboard navigation.
- To align with our goals of design modernization and consistent user
experience.

    **Impact:**

`LegacySegmentedControl` component is no longer available and cannot be
used in your projects. Replace all instances of `LegacySegmentedControl`
with `SegmentedControl` component.

- **Breaking Changes: Property updates in `LegacyStack` components**
([#1944](#1944)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
    -   No longer export `AxisAlignment` type.

- **Breaking Changes: Property updates in `TextField` component**
([#1904](#1904)) by
@sungik-choi

- No longer support `interpolation`-related properties. Replace any
usage of `interpolation` -related properties with appropriate `***style`
or `***className` implementations.
- No longer support `inputStyle` and `inputClassName` properties.
Replace any usage of `inputStyle` and `inputClassName` with appropriate
`style` or `className` implementations.
    -   Change the value of `TextFieldVariant` enum value to string.

- **Breaking Changes: Remove the default offset(`GNB_WIDTH`) in
`Toast`**
([#2117](#2117)) by
@sungik-choi

Remove the style because it was dependent on a specific application. Use
`{ left: 68 }` instead.

- **Breaking Changes: Property updates in `Banner` component**
([#1891](#1891)) by
@sungik-choi

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

    **Other changes in `Banner` component**

    -   now supports HTML attributes.
    -   now supports style props.

- **Breaking Change: Removal of `LegacyRadio` Component**
([#1943](#1943)) by
@sungik-choi

- `LegacyRadio` component has been removed from the library. Please use
`RadioGroup` and `Radio` component instead.
- Now if `Radio` has no label, its size is reduced by an indicator.

- **Breaking Changes: Property updates in `Checkbox` component**
([#1918](#1918)) by
@sungik-choi

No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.

- **Breaking Changes: Property updates in `Switch` component**
([#1885](#1885)) by
@yangwooseong

No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.

- Export the css style sheet for the new design system.
([#1492](#1492)) by
@sungik-choi

- **Breaking Changes: Reorganizing `OutlineItem` component**
([#1930](#1930)) by
@sungik-choi

`OutlineItem` component was originally designed as a component to draw a
tree-like view, _but it was not used as intended in production_. We
simplified the component's responsibilities by removing unused
properties while retaining the component's ability to apply indentation
to subcomponents.

- No longer support `paddingLeft` property. **By default, 6px of left
padding has been added.** If you need to make changes, override the
style.
- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `iconStyle`, `iconClassName`, `iconInterpolation`,
`contentStyle`, `contentClassName` and `contentInterpolation`. This
decision was made to reduce excessive flexibility in the interface.
- No longer support `leftIcon` property. Removed for consistency with
other component interfaces. Replace it to `leftContent`.
    -   No longer support `leftIconColor` and `leftIconTestId` property.
- No longer support `name` property. The second argument (name) of
`onClick` is also removed. If you need an identifier, combine functions
outside of the component.
- No longer support `hide`, `optionKey` and `disableIconActive`
property. Replace `hide` property with conditional rendering.
- No longer support `onOpen`, `onClickArrow`, `selectedOutlineItemIndex`
and `onChangeOption` property.

- **Breaking Changes: Property updates in `Slider` component**
([#1883](#1883)) by
@yangwooseong

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- `dir` type is narrowed from `string | undefined` to `ltr | rtl |
undefined`

- **Breaking Changes: Property updates in `Button` component**
([#1882](#1882)) by
@sungik-choi

- No longer support `interpolation` property. Replace any usage of
`interpolation` property with appropriate `style` or `className`
implementations.
- `ButtonSize` and `ButtonColorVariant` enums have been updated to use
kebab case.

- **Breaking Change: No longer supports `smoothCorners` mixin. Use
`AlphaSmoothCornersBox` components instead.**
([#1892](#1892)) by
@sungik-choi

    ```tsx
    // Before
    const Box = styled.div`
      ${smoothCorners({
        borderRadius: 10,
        shadow: '0 5px 15px 0 var(--shdw-large)',
        shadowBlur: 15,
        backgroundColor: 'var(--bgtxt-absolute-white-dark)',
        hasBackgroundImage: true,
      })}
    `

    <Box>...</Box>

    // After
    <AlphaSmoothCornersBox
      borderRadius={10}
      shadow={{
        offsetX: 0,
        offsetY: 5,
        blurRadius: 15,
        spreadRadius: 0,
        color: 'shdw-large',
      }}
      backgroundColor="bgtxt-absolute-white-dark"
      backgroundImage="..."
    >...</AlphaSmoothCornersBox>
    ```

- **Breaking Changes: `Toast`-related modules**
([#1950](#1950)) by
@sungik-choi

- No longer support `actionContent` and `onClick` properties in
`ToastOptions`.
- Value type of `zIndex` property in `ToastOptions` is changed from
`number` to `ZIndex` token.
    -   No longer export `ToastIconColor` enum.

- **Breaking Changes: Property updates in `TextArea` component**
([#1914](#1914)) by
@sungik-choi

- No longer support `as` and `interpolation` property. Replace any usage
of `interpolation` property with appropriate `style` or `className`
implementations.
- No longer support `wrapperStyle`, `wrapperClassName` and
`wrapperInterpolation` property. It was never properly implemented
before, and the Wrapper element inside was also removed.

- **Breaking Changes: Deprecate support for `styled-components` related
modules**
([#1962](#1962)) by
@sungik-choi

- No longer support legacy foundation modules. Use the `useToken` hook
and components to replace it
        -   `LightFoundation` and `DarkFoundation`
        -   `Spacing`
        -   `ev1`, `ev2`, `ev3`, `ev4`, `ev5` and `ev6`
- `createThemes`, `Theme`, `SemanticNames`, `LightTheme` and `DarkTheme`
        -   `TransitionDuration` and `Transition`
        -   `Border`
- `Typography`, `TypoAbsoluteNumber`, `LineHeightAbsoluteNumber` and
`TypographyType`
- `absoluteCenter`, `disableAutoMinimum`, `hideScrollbars` and
`ellipsis`
        -   `ThemeVarsAdditionalType` and `ThemeVars`
        -   `GlobalStyle`
        -   `Foundation`
        -   `GlobalStyleProp`
- `createGlobalStyle`, `styled`, `css`, `FoundationProvider`,
`useFoundation`, `keyframes`, `StyleSheetManager` and `ServerStyleSheet`
- No longer support `BezierProvider`. Use the `AppProvider` instead
- No longer support `gap` and `touchableHover` mixins. Please implement
and use your own

    ```tsx
    function gap(spacing: number): InjectedInterpolation {
      return css`
        gap: ${spacing}px;

        @supports not (gap: ${spacing}px) {
          margin-top: ${-spacing}px;
          margin-left: ${-spacing}px;

          > * {
            margin-top: ${spacing}px;
            margin-left: ${spacing}px;
          }
        }
      `;
    }

    function touchableHover(
      interpolation: InjectedInterpolation,
    ): InjectedInterpolation {
      return css`
        @media (hover: hover) {
          &:hover {
            ${interpolation}
          }
        }

        @media (hover: none) {
          &:active {
            ${interpolation}
          }
        }
      `;
    }
    ```

- No longer support `inputTextStyle`, `inputPlaceholderStyle`,
`inputWrapperStyle`, `focusedInputWrapperStyle` and
`erroredInputWrapperStyle`. Please migrate using
`@channel.io/bezier-codemod`'s `v2-interpolation-to-css-variable`
transformer.

- **Breaking Changes: `AlphaStack` component has been changed to a
`Stack` component, and `Stack` component has been changed to
`LegacyStack` component.**
([#1837](#1837)) by
@sungik-choi

Changes to remove the dependency of `Stack` and `StackItem` to allow
stack layouts to be configured without additional DOM elements. And
improved the existing `AlphaStack` to support more Flex layout related
properties like reverse, wrap, and more align options, etc. See
StackProps for more information.

We also added new `HStack` and `VStack` components, which are shorthand
components that fix the direction prop of `AlphaStack`. As mentioned
above, the existing components become `LegacyHStack`, `LegacyVStack`.

The layout implemented by `StackItem` can be partially replaced by the
Layout component's `grow`, `shrink` common properties and margin common
properties. Note that the `align`, `justify` (align-self, justify-self
in CSS flex) properties provided by `StackItem` are not provided by the
Layout component.

    ```jsx
    /* AS-IS */
    return (
      <Stack
        direction="horizontal"
        spacing={8}
        style={{ width: 300, height: 50 }}
      >
        <StackItem grow shrink weight={1} />
        <StackItem weight={0} size={10} marginBefore={20}>
          <Stack direction="vertical" />
        </StackItem>
      </Stack>
    );

    /* TO-BE */
    return (
      <Stack direction="horizontal" spacing={8} width={300} height={50}>
        <Box grow={1} shrink={1} />
        <Stack direction="vertical" shrink={0} width={10} ml={12} />
      </Stack>
    );
    ```

The changes also apply to other components that use `Stack` internally,
and there are a few breaking changes.

- `RadioGroup`, `ButtonGroup`, `FormGroup` no longer support `as` prop.

- **Breaking Change: Removal of `ListMenuTitle` Component**
([#1900](#1900)) by
@yangwooseong

    -   It was no longer being managed or utilized by our designers.
- If you are currently using `ListMenuTitle` in your application, please
replace it with the `SectionLabel` component for similar functionality.

### Minor Changes

- Implement multi theme feature based on data attributes
([#1756](#1756)) by
@sungik-choi

- Move `@channel.io/bezier-tokens` from dev depdency to dependency
([#1985](#1985)) by
@sungik-choi

- Add the `TooltipPrimitive` component, which is the same as the
[`Tooltip` component in
radix-ui](https://www.radix-ui.com/primitives/docs/components/tooltip).
You can use it by importing it from the `/alpha` path.
([#2049](#2049)) by
@sungik-choi

    ```tsx
    import {
      TooltipPrimitive,
      TooltipPrimitiveArrow,
      TooltipPrimitiveContent,
      TooltipPrimitivePortal,
      TooltipPrimitiveProvider,
      TooltipPrimitiveTrigger,
    } from "@channel.io/bezier-react/alpha";
    ```

- When you pass a value of number type to the dimension-related
properties of margin prop and layout prop, they implicitly add px units
as a suffix. See:
<https://react.dev/reference/react-dom/components/common#common>
([#1823](#1823)) by
@sungik-choi

- Add `Box` component. `Box` component is responsible for the primitive
layout and provides easy access to the design tokens in the design
system ([#1785](#1785))
by @sungik-choi

    ```tsx
<Box width="100px" height="100px" p="6px" m="6px"
bgColor="bg-black-light" />
    ```

- Fixes style inheritance issues by explicitly giving CSS custom
properties an initial value
([#1846](#1846)) by
@sungik-choi

- Apply bezier-tokens to bezier-react's style sheet and fix some invalid
css selector
([#1495](#1495)) by
@sungik-choi

- Add the `DialogPrimitive` component, which is the same as the
[`Dialog` component in
radix-ui](https://www.radix-ui.com/primitives/docs/components/dialog).
You can use it by importing it from the `/alpha` path.
([#2049](#2049)) by
@sungik-choi

    ```tsx
    import {
      DialogPrimitive,
      DialogPrimitiveClose,
      DialogPrimitiveContent,
      DialogPrimitiveDescription,
      DialogPrimitiveOverlay,
      DialogPrimitivePortal,
      DialogPrimitiveTitle,
      DialogPrimitiveTrigger,
    } from "@channel.io/bezier-react/alpha";
    ```

- `ButtonGroup` now supports HTML attributes
([#1890](#1890)) by
@sungik-choi

- `Banner` will now render content even if the `content` prop is not a
string. The same applies to link-related props.
([#1972](#1972)) by
@sungik-choi

- Rename `AlphaAppProvider` to `AppProvider`
([#1834](#1834)) by
@sungik-choi

- Rename the `style.css` file to `styles.css`
([#1791](#1791)) by
@sungik-choi

- Add `align` prop to `Text` component. This prop is used to set
horizontal alignment of text
([#1820](#1820)) by
@sungik-choi

    ```tsx
    <Text align="left" />
    <Text align="center" />
    <Text align="right" />
    ```

- Remove `borderStyle` prop from Layout props
([#1848](#1848)) by
@sungik-choi

- Add `useRootElement` hook. It is only available to `WindowProvider`
children, and provides easy access to the root element of window context
value. ([#1981](#1981))
by @sungik-choi

    ```tsx
    const { window, document, rootElement } = useWindow();
    // Same as useWindow().rootElement
    const rootElement = useRootElement();
    ```

### Patch Changes

- Fixes an issue with color inheritance across components.
([#2009](#2009)) by
@sungik-choi

- Add missing default margin styles of `LegacyStackItem`
([#2004](#2004)) by
@sungik-choi

- Fixes issue with `ModalBody`, `ModalFooter` not applying styling
correctly when wrapped in other elements.
([#2017](#2017)) by
@sungik-choi

- Add `overflow: hidden` to `ListItem` component
([#2013](#2013)) by
@yangwooseong

- Fix invalid `aria-modal` value in Modal Content.
([#2052](#2052)) by
@sungik-choi

- Fix `TabAction` typography style for size M.
([#2035](#2035)) by
@sungik-choi

- Minify the CSS output
([#1791](#1791)) by
@sungik-choi

- Update background color of `TextField`'s secondary variant.
([#2016](#2016)) by
@sungik-choi

- Mute the error of `smoothCornerScript` when called twice.
([#2010](#2010)) by
@chaejunlee

- Now exports the `tokens` object from `@channel.io/bezier-tokens`.
([#1992](#1992)) by
@sungik-choi

- Adds icon and typo size for avatar size `"72"`, which were missing
from `AvatarGroup`.
([#2071](#2071)) by
@sungik-choi

- Add missing `overflow: hidden` style to item wrapper of `KeyValueItem`
component.
([#2036](#2036)) by
@sungik-choi

- Fixes `Overlay` not closing in other windows.
([#2037](#2037)) by
@sungik-choi

- Fixes a bug where onHide is called when clicking inside the overlay,
causing the overlay to close.
([#1977](#1977)) by
@yangwooseong

- Fix invalid style migrations of `Tabs` component.
([#2014](#2014)) by
@sungik-choi

- Add missing spreading props to `ThemeProvider` and related components.
([#1986](#1986)) by
@sungik-choi

- Fix `ListItem`'s left icon color specificity issue.
([#2018](#2018)) by
@sungik-choi

- Fix `Badge` component style issue
([#2068](#2068)) by
@yangwooseong

- Fixes an issue where multi line truncated in `Text` was not being
applied. ([#1994](#1994))
by @sungik-choi

-   Updated dependencies
    -   @channel.io/bezier-tokens@0.1.0

## @channel.io/bezier-codemod@0.5.0

### Minor Changes

- Changes in `v2-text-component-interface` codemod
([#1932](#1932)) by
@yangwooseong
Previously, both the component name and the name of the property were
checked, but now only the name of the component property is checked.

- Add codemod for Stack component
([#1836](#1836)) by
@yangwooseong

- Add more various cases to `v2-enum-member-to-string-literal`
([#2059](#2059)) by
@yangwooseong

- Fix typo in `v2-z-index-interpolation-to-css-variable` codemod. It now
transforms `${ZIndex.Float}` enum to `var(--z-index-floating)`, not
`var(--z-index-float)`.
([#1924](#1924)) by
@yangwooseong

- Add codemod to transform interface of `Text` component
([#1849](#1849)) by
@yangwooseong

- Enhancement in `v2-foundation-to-css-variable-transition` codemod
([#1917](#1917)) by
@yangwooseong

- It will properly remove import statement if it converts code where
`TransitionDuration` is used.

- Changes in `v2-remove-alpha-from-alpha-stack` transform
([#1894](#1894)) by
@yangwooseong

    -   It is renamed as `v2-remove-alpha-from-alpha-components`.
    -   It covers `AlphaCenter` as well.

- Add `v2-foundation-to-css-variable-spacing` codemod to convert the
foundation's spacing variable to pixels
([#1907](#1907)) by
@yangwooseong

    This transforms

    ```tsx
    import { styled } from "@channel.io/bezier-react";

    export const Wrapper = styled.div`
      padding: ${({ foundation }) => foundation?.spacing.s5};
    `;
    ```

    into

    ```tsx
    import { styled } from "@channel.io/bezier-react";

    export const Wrapper = styled.div`
      padding: 12px;
    `;
    ```

- Changes in `v2-**-interpolation-to-css-variable` transform.
([#1928](#1928)) by
@yangwooseong

- it is renamed to `v2-interpolation-to-css-variable-**`. e.g.
`v2-interpolation-to-css-varable-input`,
`v2-interpolation-to-css-variable-typography`, and so on
- it provides integrated transform named
`v2-interpolation-to-css-variable` that handles all interpolation
transform

- Enhance `import-styled-from-styled-component` codemod to cover other
APIs from `styled-components`
([#1852](#1852)) by
@yangwooseong

- Add `Typography` transform logic to interpolation codemod
([#1841](#1841)) by
@yangwooseong

- Add v2 prefix to codemods related to major version 2
([#1844](#1844)) by
@yangwooseong

- Add codemod for z-index interpolation and enum
([#1845](#1845)) by
@yangwooseong

- Add more various cases to `v2-enum-member-to-string-literal`. Now it
covers following enums.
([#2059](#2059)) by
@yangwooseong

    -   `AvatarGroupEllipsisType`
    -   `IconSize`
    -   `LegacyTooltipPosition`
    -   `ModalTitleSize`
    -   `OverlayPosition`
    -   `ProgressBarSize`, `ProgressBarVariant`
    -   `SpinnerSize`
    -   `SwitchSize`
    -   `TagBadgeSize`, `TagBadgeVariant`
    -   `TextAreaHeight`
    -   `TextFieldSize`, `TextFieldVariant`
    -   `ToastPlacement`, `ToastAppearance`, `ToastPreset`
    -   `TooltipPosition`

- Add `inputPlaceholderStyle` migration logic to
`v2-input-interpolation-to-css-variable` codemod
([#1926](#1926)) by
@yangwooseong

- Add transform functions to help to migrate foundation to css variable
generated by `@channel.io/bezier-tokens` package. They cover theme,
transition, elevation, rounding, and border of foundation
([#1781](#1781)) by
@yangwooseong

- Added a codemod to switch the library for importing 'styled' object
from @channel.io/bezier-react to styled-components
([#1789](#1789)) by
@yangwooseong

- Add codemod for mixin interpolation
([#1787](#1787)) by
@yangwooseong

### Patch Changes

- Fix bug in `v2-import-from-bezier-to-styled-components` codemod when
there are only named imports as following:
([#1987](#1987)) by
@yangwooseong

    ```tsx
    // As-is
    import { css } from "@channel.io/bezier-react";

    // To-be
    import { css } from "styled-components";
    ```

- Fix `hasNamedImportInImportDeclaration` util to check all named
imports ([#2060](#2060))
by @yangwooseong

## @channel.io/bezier-tokens@0.1.0

### Minor Changes

- Apply deep freeze to the `tokens` object.
([#1992](#1992)) by
@sungik-choi

- Add the missing `bg-header-float` semantic color token
([#1842](#1842)) by
@sungik-choi

- Add composition tokens, such as box-shadow
([#1769](#1769)) by
@sungik-choi

- Now serving one combined styles.css file. This is a breaking change
for anyone who was importing the individual CSS files. You will need to
update your import to `@channel.io/bezier-tokens/css/styles.css`.
([#1769](#1769)) by
@sungik-choi

- Add z-index and opacity tokens
([#1766](#1766)) by
@sungik-choi

- Remove invalid radius tokens
([#1934](#1934)) by
@sungik-choi

    -   `radius-10`
    -   `radius-14`
    -   `radius-100-p`

- Fix invalid letter spacing token values
([#1821](#1821)) by
@sungik-choi

- First release
([#1685](#1685)) by
@sungik-choi

- Add categories by token to the JavaScript build file
([#1766](#1766)) by
@sungik-choi

- Remove unused tokens and add missing unit to radius tokens
([#1752](#1752)) by
@sungik-choi

### Patch Changes

- Remove duplicate styles in styles.css
([#1779](#1779)) by
@sungik-choi

## bezier-figma-plugin@0.5.0

### Minor Changes

- Upgrade to use @channel.io/bezier-react@2.0.0
([#2001](#2001)) by
@sungik-choi

### Patch Changes

- Enhance icon extract logic by catching error
([#2073](#2073)) by
@yangwooseong

-   Updated dependencies
    -   @channel.io/bezier-react@2.0.0

## @channel.io/bezier-vscode@0.1.0

### Minor Changes

- Create a package to support autocomplete for Bezier Design Tokens
([#2091](#2091)) by
@yangwooseong

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bezier-codemod Issue or PR related to bezier-codemod
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Writing code to convert Typography of TextProps.typo to typo string literal
2 participants