Skip to content

[Page] Deprecate thumbnail property #4733

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
Nov 26, 2021
Merged

[Page] Deprecate thumbnail property #4733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4991ed
[Page] Deprecate thumbnail property
alex-page Nov 25, 2021
fff051d
Update UNRELEASED.md
alex-page Nov 25, 2021
e77dcde
Update unreleased.md add warning log
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 @@ -53,3 +53,4 @@ Use [the changelog guidelines](/documentation/Versioning%20and%20changelog.md) t
### Deprecations

- 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))
7 changes: 6 additions & 1 deletion src/components/Page/components/Header/components/Title/Title.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export interface TitleProps {
subtitle?: string;
/** Important and non-interactive status information shown immediately after the title. */
titleMetadata?: React.ReactNode;
/** thumbnail that precedes the title */
/** @deprecated thumbnail that precedes the title */
thumbnail?:
| React.ReactElement<AvatarProps | ThumbnailProps>
| React.SFC<React.SVGProps<SVGSVGElement>>;
Expand All @@ -28,6 +28,11 @@ export function Title({
thumbnail,
compactTitle,
}: TitleProps) {
if (process.env.NODE_ENV === 'development' && thumbnail != null) {
// eslint-disable-next-line no-console
console.warn('The thumbnail prop from Page has been deprecated');
}

const titleMarkup = title ? <h1 className={styles.Title}>{title}</h1> : null;

const titleMetadataMarkup = titleMetadata ? (
Expand Down