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

Polaris tokens major version upgrades #10801

Merged
merged 33 commits into from
Oct 3, 2023
Merged

Conversation

aaronccasanova
Copy link
Member

@aaronccasanova aaronccasanova commented Sep 29, 2023

This PR introduces breaking changes, including additions and deprecations, as part of the major version upgrade to @shopify/polaris-tokens. The key changes include:

  • Introduced themeNameDefault constant.
  • Deprecated tokens export (replace with themeDefault).
  • Introduced themeDefault export (convenience alias for themes[themeNameDefault]).
  • Deprecated all individual token group exports e.g. color, space, motion, etc...
  • Deprecated metadata export (replace with metaThemeDefault).
  • Introduced metaThemeDefault export (convenience alias for metaThemes[themeNameDefault]).
  • Introduced new theme types:
    • ThemeName
    • MetaTheme
    • MetaThemeShape
    • MetaTokenGroupShape
    • MetaTokenProperties
    • Theme
  • Renamed MetadataGroup to MetaTokenGroupShape.
  • Renamed getCustomPropertyNames to getThemeVarNames.
  • Introduced isTokenName type guard (ensure an unknown value is a valid theme token).
  • Updated createVar utility (now creates a complete CSS variable function e.g.
// Before:
createVar('token-name') //=> '--p-token-name'
// After:
createVar('token-name') //=> 'var(--p-token-name)'
  • Renamed createVar to createVarName.
  • Introduced createVarName utility (behaves similar to the legacy createVar utility).
  • Exposed metaThemes object containing all meta theme objects (useful for low level integrations such as the Polaris site, Polaris for VS Code, etc...).
  • Deprecated a collection of unintentionally exposed Polaris utils and types:
    • getUnit
    • toEm
    • rem
    • tokensToRems
    • getKeyframeNames
    • removeMetadata
    • MetaBreakpointsTokenGroup
    • BreakpointsAliasDirectionMediaConditions
    • BreakpointsMediaConditions
    • isKeyOf
    • createExact
    • createMetadata
  • Deprecated @shopify/polaris-tokens/json entry point.

aaronccasanova and others added 30 commits September 29, 2023 13:50
@aaronccasanova aaronccasanova marked this pull request as ready for review October 3, 2023 18:55
@aaronccasanova aaronccasanova self-assigned this Oct 3, 2023
@aaronccasanova aaronccasanova merged commit 2cdc59f into next Oct 3, 2023
12 checks passed
@aaronccasanova aaronccasanova deleted the polaris-tokens-deprecations branch October 3, 2023 19:37
sophschneider added a commit that referenced this pull request Oct 3, 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 next, this PR will
be updated.

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

`next` 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 `next`.

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

# Releases
## @shopify/polaris@12.0.0-beta.2

### Major Changes

- [#10705](#10705)
[`c7c2312f7`](c7c2312)
Thanks [@chloerice](https://github.com/chloerice)! - - Removed the
`subdued` and `status` props from `IndexTable.Row`. Use `tone` instead.


- [#10778](#10778)
[`b126f64e6`](b126f64)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `shadow`
custom properties from v11 to v12


- [#10762](#10762)
[`1ef71164c`](1ef7116)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `font` custom
properties from v11 to v12


- [#10741](#10741)
[`2c2bb0e09`](2c2bb0e)
Thanks [@laurkim](https://github.com/laurkim)! - - Migrated `border`
custom properties from v11 to v12
- Removed backwards compatibility for v11 border tokens on `Tooltip`
component `BorderRadius` type
- Updated JSDoc prop type descriptions to include updated `border`
custom properties on `Divider` and `Tooltip` components


- [#10744](#10744)
[`a4f5e7df3`](a4f5e7d)
Thanks [@mrcthms](https://github.com/mrcthms)! - Removed deprecated
`disable1Password` prop from `TextField`.


- [#10727](#10727)
[`179b481d7`](179b481)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `space` custom
properties from v11 to v12
Removed backwards compatibility for v11 border tokens on `Tooltip`
component `Padding` type
Updated JSDoc prop type descriptions to include updated `padding` custom
properties on `Box` component


- [#10669](#10669)
[`794d1f5e4`](794d1f5)
Thanks [@lgriffee](https://github.com/lgriffee)! - Added `border-radius`
semantic layer


- [#10745](#10745)
[`a4205eee1`](a4205ee)
Thanks [@mrcthms](https://github.com/mrcthms)! - [IndexFilters] Remove
IndexFiltersManager in AppProvider


- [#10773](#10773)
[`f6bc29ade`](f6bc29a)
Thanks [@laurkim](https://github.com/laurkim)! - Removed support for
`headingXs` and `heading4xl` variants and replaced usage with
`headingSm` and `heading3xl`

### Minor Changes

- [#10722](#10722)
[`14a94967d`](14a9496)
Thanks [@laurkim](https://github.com/laurkim)! - Added support for
`emphasis` and `text` tones on `Icon` and migrated `primary` and
`subdued` tone color tokens


- [#10788](#10788)
[`82f10e830`](82f10e8)
Thanks [@mrcthms](https://github.com/mrcthms)! - Deprecated the
IndexFiltersManager component

### Patch Changes

- Updated dependencies
\[[`2a467249f`](2a46724),
[`2cdc59f88`](2cdc59f),
[`794d1f5e4`](794d1f5),
[`08aaf11ec`](08aaf11)]:
    -   @shopify/polaris-tokens@8.0.0-beta.1

## @shopify/polaris-tokens@8.0.0-beta.1

### Major Changes

- [#10760](#10760)
[`2a467249f`](2a46724)
Thanks [@lgriffee](https://github.com/lgriffee)! - Updated `shadow`
token values


- [#10801](#10801)
[`2cdc59f88`](2cdc59f)
Thanks [@aaronccasanova](https://github.com/aaronccasanova)! -
Deprecated a collection of types, utils, and JSON exports


- [#10673](#10673)
[`08aaf11ec`](08aaf11)
Thanks [@lgriffee](https://github.com/lgriffee)! - Updated `font-size`
and `font-weight` token values

### Minor Changes

- [#10669](#10669)
[`794d1f5e4`](794d1f5)
Thanks [@lgriffee](https://github.com/lgriffee)! - Added `border-radius`
semantic layer

## @shopify/stylelint-polaris@14.1.2-beta.1

### Patch Changes

- Updated dependencies
\[[`2a467249f`](2a46724),
[`2cdc59f88`](2cdc59f),
[`794d1f5e4`](794d1f5),
[`08aaf11ec`](08aaf11)]:
    -   @shopify/polaris-tokens@8.0.0-beta.1

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sophie Schneider <thesophieschneider@gmail.com>
mrcthms pushed a commit that referenced this pull request Oct 12, 2023
This PR introduces breaking changes, including additions and
deprecations, as part of the major version upgrade to
`@shopify/polaris-tokens`. The key changes include:

- Introduced `themeNameDefault` constant.
- Deprecated `tokens` export (replace with `themeDefault`).
- Introduced `themeDefault` export (convenience alias for
`themes[themeNameDefault]`).
- Deprecated all individual token group exports e.g. `color`, `space`,
`motion`, etc...
- Deprecated `metadata` export (replace with `metaThemeDefault`).
- Introduced `metaThemeDefault` export (convenience alias for
`metaThemes[themeNameDefault]`).
- Introduced new theme types:
  * `ThemeName`
  * `MetaTheme`
  * `MetaThemeShape`
  * `MetaTokenGroupShape`
  * `MetaTokenProperties`
  * `Theme`
- Renamed `MetadataGroup` to `MetaTokenGroupShape`.
- Renamed `getCustomPropertyNames` to `getThemeVarNames`.
- Introduced `isTokenName` type guard (ensure an unknown value is a
valid theme token).
- Updated `createVar` utility (now creates a complete CSS variable
function e.g.
```ts
// Before:
createVar('token-name') //=> '--p-token-name'
// After:
createVar('token-name') //=> 'var(--p-token-name)'
```
- Renamed `createVar` to `createVarName`.
- Introduced `createVarName` utility (behaves similar to the legacy
`createVar` utility).
- Exposed `metaThemes` object containing all meta theme objects (useful
for low level integrations such as the Polaris site, Polaris for VS
Code, etc...).
- Deprecated a collection of unintentionally exposed Polaris utils and
types:
  * `getUnit`
  * `toEm`
  * `rem`
  * `tokensToRems`
  * `getKeyframeNames`
  * `removeMetadata`
  * `MetaBreakpointsTokenGroup`
  * `BreakpointsAliasDirectionMediaConditions`
  * `BreakpointsMediaConditions`
  * `isKeyOf`
  * `createExact`
  * `createMetadata`
- Deprecated `@shopify/polaris-tokens/json` entry point.

---------

Co-authored-by: Sophie Schneider <thesophieschneider@gmail.com>
mrcthms pushed a commit that referenced this pull request Oct 12, 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 next, this PR will
be updated.

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

`next` 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 `next`.

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

- [#10705](#10705)
[`c7c2312f7`](c7c2312)
Thanks [@chloerice](https://github.com/chloerice)! - - Removed the
`subdued` and `status` props from `IndexTable.Row`. Use `tone` instead.

- [#10778](#10778)
[`b126f64e6`](b126f64)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `shadow`
custom properties from v11 to v12

- [#10762](#10762)
[`1ef71164c`](1ef7116)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `font` custom
properties from v11 to v12

- [#10741](#10741)
[`2c2bb0e09`](2c2bb0e)
Thanks [@laurkim](https://github.com/laurkim)! - - Migrated `border`
custom properties from v11 to v12
- Removed backwards compatibility for v11 border tokens on `Tooltip`
component `BorderRadius` type
- Updated JSDoc prop type descriptions to include updated `border`
custom properties on `Divider` and `Tooltip` components

- [#10744](#10744)
[`a4f5e7df3`](a4f5e7d)
Thanks [@mrcthms](https://github.com/mrcthms)! - Removed deprecated
`disable1Password` prop from `TextField`.

- [#10727](#10727)
[`179b481d7`](179b481)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `space` custom
properties from v11 to v12
Removed backwards compatibility for v11 border tokens on `Tooltip`
component `Padding` type
Updated JSDoc prop type descriptions to include updated `padding` custom
properties on `Box` component

- [#10669](#10669)
[`794d1f5e4`](794d1f5)
Thanks [@lgriffee](https://github.com/lgriffee)! - Added `border-radius`
semantic layer

- [#10745](#10745)
[`a4205eee1`](a4205ee)
Thanks [@mrcthms](https://github.com/mrcthms)! - [IndexFilters] Remove
IndexFiltersManager in AppProvider

- [#10773](#10773)
[`f6bc29ade`](f6bc29a)
Thanks [@laurkim](https://github.com/laurkim)! - Removed support for
`headingXs` and `heading4xl` variants and replaced usage with
`headingSm` and `heading3xl`

- [#10722](#10722)
[`14a94967d`](14a9496)
Thanks [@laurkim](https://github.com/laurkim)! - Added support for
`emphasis` and `text` tones on `Icon` and migrated `primary` and
`subdued` tone color tokens

- [#10788](#10788)
[`82f10e830`](82f10e8)
Thanks [@mrcthms](https://github.com/mrcthms)! - Deprecated the
IndexFiltersManager component

- Updated dependencies
\[[`2a467249f`](2a46724),
[`2cdc59f88`](2cdc59f),
[`794d1f5e4`](794d1f5),
[`08aaf11ec`](08aaf11)]:
    -   @shopify/polaris-tokens@8.0.0-beta.1

- [#10760](#10760)
[`2a467249f`](2a46724)
Thanks [@lgriffee](https://github.com/lgriffee)! - Updated `shadow`
token values

- [#10801](#10801)
[`2cdc59f88`](2cdc59f)
Thanks [@aaronccasanova](https://github.com/aaronccasanova)! -
Deprecated a collection of types, utils, and JSON exports

- [#10673](#10673)
[`08aaf11ec`](08aaf11)
Thanks [@lgriffee](https://github.com/lgriffee)! - Updated `font-size`
and `font-weight` token values

- [#10669](#10669)
[`794d1f5e4`](794d1f5)
Thanks [@lgriffee](https://github.com/lgriffee)! - Added `border-radius`
semantic layer

- Updated dependencies
\[[`2a467249f`](2a46724),
[`2cdc59f88`](2cdc59f),
[`794d1f5e4`](794d1f5),
[`08aaf11ec`](08aaf11)]:
    -   @shopify/polaris-tokens@8.0.0-beta.1

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sophie Schneider <thesophieschneider@gmail.com>
mrcthms pushed a commit that referenced this pull request Oct 12, 2023
This PR introduces breaking changes, including additions and
deprecations, as part of the major version upgrade to
`@shopify/polaris-tokens`. The key changes include:

- Introduced `themeNameDefault` constant.
- Deprecated `tokens` export (replace with `themeDefault`).
- Introduced `themeDefault` export (convenience alias for
`themes[themeNameDefault]`).
- Deprecated all individual token group exports e.g. `color`, `space`,
`motion`, etc...
- Deprecated `metadata` export (replace with `metaThemeDefault`).
- Introduced `metaThemeDefault` export (convenience alias for
`metaThemes[themeNameDefault]`).
- Introduced new theme types:
  * `ThemeName`
  * `MetaTheme`
  * `MetaThemeShape`
  * `MetaTokenGroupShape`
  * `MetaTokenProperties`
  * `Theme`
- Renamed `MetadataGroup` to `MetaTokenGroupShape`.
- Renamed `getCustomPropertyNames` to `getThemeVarNames`.
- Introduced `isTokenName` type guard (ensure an unknown value is a
valid theme token).
- Updated `createVar` utility (now creates a complete CSS variable
function e.g.
```ts
// Before:
createVar('token-name') //=> '--p-token-name'
// After:
createVar('token-name') //=> 'var(--p-token-name)'
```
- Renamed `createVar` to `createVarName`.
- Introduced `createVarName` utility (behaves similar to the legacy
`createVar` utility).
- Exposed `metaThemes` object containing all meta theme objects (useful
for low level integrations such as the Polaris site, Polaris for VS
Code, etc...).
- Deprecated a collection of unintentionally exposed Polaris utils and
types:
  * `getUnit`
  * `toEm`
  * `rem`
  * `tokensToRems`
  * `getKeyframeNames`
  * `removeMetadata`
  * `MetaBreakpointsTokenGroup`
  * `BreakpointsAliasDirectionMediaConditions`
  * `BreakpointsMediaConditions`
  * `isKeyOf`
  * `createExact`
  * `createMetadata`
- Deprecated `@shopify/polaris-tokens/json` entry point.

---------

Co-authored-by: Sophie Schneider <thesophieschneider@gmail.com>
mrcthms pushed a commit that referenced this pull request Oct 12, 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 next, this PR will
be updated.

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

`next` 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 `next`.

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

- [#10705](#10705)
[`c7c2312f7`](c7c2312)
Thanks [@chloerice](https://github.com/chloerice)! - - Removed the
`subdued` and `status` props from `IndexTable.Row`. Use `tone` instead.

- [#10778](#10778)
[`b126f64e6`](b126f64)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `shadow`
custom properties from v11 to v12

- [#10762](#10762)
[`1ef71164c`](1ef7116)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `font` custom
properties from v11 to v12

- [#10741](#10741)
[`2c2bb0e09`](2c2bb0e)
Thanks [@laurkim](https://github.com/laurkim)! - - Migrated `border`
custom properties from v11 to v12
- Removed backwards compatibility for v11 border tokens on `Tooltip`
component `BorderRadius` type
- Updated JSDoc prop type descriptions to include updated `border`
custom properties on `Divider` and `Tooltip` components

- [#10744](#10744)
[`a4f5e7df3`](a4f5e7d)
Thanks [@mrcthms](https://github.com/mrcthms)! - Removed deprecated
`disable1Password` prop from `TextField`.

- [#10727](#10727)
[`179b481d7`](179b481)
Thanks [@laurkim](https://github.com/laurkim)! - Migrated `space` custom
properties from v11 to v12
Removed backwards compatibility for v11 border tokens on `Tooltip`
component `Padding` type
Updated JSDoc prop type descriptions to include updated `padding` custom
properties on `Box` component

- [#10669](#10669)
[`794d1f5e4`](794d1f5)
Thanks [@lgriffee](https://github.com/lgriffee)! - Added `border-radius`
semantic layer

- [#10745](#10745)
[`a4205eee1`](a4205ee)
Thanks [@mrcthms](https://github.com/mrcthms)! - [IndexFilters] Remove
IndexFiltersManager in AppProvider

- [#10773](#10773)
[`f6bc29ade`](f6bc29a)
Thanks [@laurkim](https://github.com/laurkim)! - Removed support for
`headingXs` and `heading4xl` variants and replaced usage with
`headingSm` and `heading3xl`

- [#10722](#10722)
[`14a94967d`](14a9496)
Thanks [@laurkim](https://github.com/laurkim)! - Added support for
`emphasis` and `text` tones on `Icon` and migrated `primary` and
`subdued` tone color tokens

- [#10788](#10788)
[`82f10e830`](82f10e8)
Thanks [@mrcthms](https://github.com/mrcthms)! - Deprecated the
IndexFiltersManager component

- Updated dependencies
\[[`2a467249f`](2a46724),
[`2cdc59f88`](2cdc59f),
[`794d1f5e4`](794d1f5),
[`08aaf11ec`](08aaf11)]:
    -   @shopify/polaris-tokens@8.0.0-beta.1

- [#10760](#10760)
[`2a467249f`](2a46724)
Thanks [@lgriffee](https://github.com/lgriffee)! - Updated `shadow`
token values

- [#10801](#10801)
[`2cdc59f88`](2cdc59f)
Thanks [@aaronccasanova](https://github.com/aaronccasanova)! -
Deprecated a collection of types, utils, and JSON exports

- [#10673](#10673)
[`08aaf11ec`](08aaf11)
Thanks [@lgriffee](https://github.com/lgriffee)! - Updated `font-size`
and `font-weight` token values

- [#10669](#10669)
[`794d1f5e4`](794d1f5)
Thanks [@lgriffee](https://github.com/lgriffee)! - Added `border-radius`
semantic layer

- Updated dependencies
\[[`2a467249f`](2a46724),
[`2cdc59f88`](2cdc59f),
[`794d1f5e4`](794d1f5),
[`08aaf11ec`](08aaf11)]:
    -   @shopify/polaris-tokens@8.0.0-beta.1

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Sophie Schneider <thesophieschneider@gmail.com>
AnnaCheba pushed a commit to AnnaCheba/polaris that referenced this pull request Apr 22, 2024
This PR introduces breaking changes, including additions and
deprecations, as part of the major version upgrade to
`@shopify/polaris-tokens`. The key changes include:

- Introduced `themeNameDefault` constant.
- Deprecated `tokens` export (replace with `themeDefault`).
- Introduced `themeDefault` export (convenience alias for
`themes[themeNameDefault]`).
- Deprecated all individual token group exports e.g. `color`, `space`,
`motion`, etc...
- Deprecated `metadata` export (replace with `metaThemeDefault`).
- Introduced `metaThemeDefault` export (convenience alias for
`metaThemes[themeNameDefault]`).
- Introduced new theme types:
  * `ThemeName`
  * `MetaTheme`
  * `MetaThemeShape`
  * `MetaTokenGroupShape`
  * `MetaTokenProperties`
  * `Theme`
- Renamed `MetadataGroup` to `MetaTokenGroupShape`.
- Renamed `getCustomPropertyNames` to `getThemeVarNames`.
- Introduced `isTokenName` type guard (ensure an unknown value is a
valid theme token).
- Updated `createVar` utility (now creates a complete CSS variable
function e.g.
```ts
// Before:
createVar('token-name') //=> '--p-token-name'
// After:
createVar('token-name') //=> 'var(--p-token-name)'
```
- Renamed `createVar` to `createVarName`.
- Introduced `createVarName` utility (behaves similar to the legacy
`createVar` utility).
- Exposed `metaThemes` object containing all meta theme objects (useful
for low level integrations such as the Polaris site, Polaris for VS
Code, etc...).
- Deprecated a collection of unintentionally exposed Polaris utils and
types:
  * `getUnit`
  * `toEm`
  * `rem`
  * `tokensToRems`
  * `getKeyframeNames`
  * `removeMetadata`
  * `MetaBreakpointsTokenGroup`
  * `BreakpointsAliasDirectionMediaConditions`
  * `BreakpointsMediaConditions`
  * `isKeyOf`
  * `createExact`
  * `createMetadata`
- Deprecated `@shopify/polaris-tokens/json` entry point.

---------

Co-authored-by: Sophie Schneider <thesophieschneider@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants