Skip to content

Create migration guidance for SkeletonPage component #5124

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 10, 2022
Merged

Create migration guidance for SkeletonPage component #5124

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f18523d
Adding migration documentation for the skeletonpage component
Feb 10, 2022
7fc060f
Running prettier
Feb 10, 2022
586cdff
Update documentation/guides/migrating-from-v8-to-v9.md
romellogoodman Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions documentation/guides/migrating-from-v8-to-v9.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Polaris v9.0.0 ([full release notes](https://github.com/Shopify/polaris-react/releases/tag/v9.0.0)) features removal of the public scss api and removal of scss functions and mixins.

## From `ThemeProvider` to `CustomProperties`
## Components

### From `ThemeProvider` to `CustomProperties`

The `ThemeProvider` has been deprecated in favor of the new `CustomProperties` component. As a result, a number of internal components using the `ThemeProvider` have been updated to use `CustomProperties` and adjusted their prop interfaces accordingly (such as: `AppProvider`, `Popover`, etc.).

Expand All @@ -28,7 +30,7 @@ The `CustomProperties` component will generate Polaris custom properties (`--p-*

> IMPORTANT: We do not officially support dark mode at this time and the example above is simply representative of the current implementation.

## `AppProvider` changes
### `AppProvider` changes

The `ThemeProvider` has been removed from the `AppProvider` and replaced with the `CustomProperties` component. Thus, the `AppProvider` no longer accepts a custom theme object. Remove the `theme` prop from the `AppProvider` and (optionally) set the `colorScheme` prop to `light` or `dark`:

Expand All @@ -45,7 +47,7 @@ const App = (props) => (
)
```

## Removed all theme types, constants, and utilities
### Removed all theme types, constants, and utilities

A number of types, constants, and utilities have been removed with the deprecation of the `ThemeProvider` component:

Expand All @@ -64,6 +66,10 @@ A number of types, constants, and utilities have been removed with the deprecati
- `UNSTABLE_toCssCustomPropertySyntax` - Utility
- `UNSTABLE_Tokens` - Constant

### `SkeletonPage`

The prop `secondaryActions` has been removed and is no longer supported.

## CSS custom properties

CSS custom properties that were renamed can be replaced with the new CSS custom property name.
Expand Down