Skip to content

[SkeletonPage] Deprecate secondaryActions #4740

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 2 commits into from
Nov 26, 2021
Merged

[SkeletonPage] Deprecate secondaryActions #4740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1b9dbd
[SkeletonPage] Deprecate secondaryActions
alex-page Nov 26, 2021
70b0c7f
Add console.warning and PR number
alex-page Nov 26, 2021
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
1 change: 1 addition & 0 deletions UNRELEASED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,4 @@ Use [the changelog guidelines](/documentation/Versioning%20and%20changelog.md) t

- Deprecated passing `attention` to the `status` prop on `Badge` in favor of `warning` ([#4658](https://github.com/Shopify/polaris-react/pull/4658))
- Deprecated `thumbnail` property for `Page` ([#4733](https://github.com/Shopify/polaris-react/pull/4733))
- Deprecated `secondaryActions` property for `SkeletonPage` ([#4740](https://github.com/Shopify/polaris-react/pull/4740))
4 changes: 2 additions & 2 deletions src/components/SkeletonPage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Use placeholder content that will change when the page fully loads. This will co
Use this component to compose a loading version of a page where the page title and header content are dynamic, meaning, the content changes.

```jsx
<SkeletonPage primaryAction secondaryActions={2}>
<SkeletonPage primaryAction>
<Layout>
<Layout.Section>
<Card sectioned>
Expand Down Expand Up @@ -115,7 +115,7 @@ Use this component to compose a loading version of a page where the page title a
Use this component to compose a loading version of a page where the page title and header content are known and stay the same.

```jsx
<SkeletonPage title="Products" primaryAction secondaryActions={2}>
<SkeletonPage title="Products" primaryAction>
<Layout>
<Layout.Section>
<Card sectioned>
Expand Down
9 changes: 8 additions & 1 deletion src/components/SkeletonPage/SkeletonPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export interface SkeletonPageProps {
narrowWidth?: boolean;
/** Shows a skeleton over the primary action */
primaryAction?: boolean;
/** Number of secondary page-level actions to display */
/** @deprecated Number of secondary page-level actions to display */
secondaryActions?: number;
/** Shows a skeleton over the breadcrumb */
breadcrumbs?: boolean;
Expand All @@ -35,6 +35,13 @@ export function SkeletonPage({
}: SkeletonPageProps) {
const i18n = useI18n();

if (process.env.NODE_ENV === 'development' && secondaryActions != null) {
// eslint-disable-next-line no-console
console.warn(
'The secondaryActions prop from SkeletonPage has been deprecated',
);
}

const className = classNames(
styles.Page,
fullWidth && styles.fullWidth,
Expand Down