diff --git a/UNRELEASED.md b/UNRELEASED.md index e8bc7a2b649..bdaece056f4 100644 --- a/UNRELEASED.md +++ b/UNRELEASED.md @@ -51,6 +51,8 @@ Use [the changelog guidelines](https://git.io/polaris-changelog-guidelines) to f ### Code quality +- Combined jsdocs in `Icon` for the `untrusted` prop ([#1607](https://github.com/Shopify/polaris-react/pull/1607)) + ### Deprecations - Deprecated all usage of the Shopify App Bridge in Polaris React ([#1573](https://github.com/Shopify/polaris-react/pull/1573)) diff --git a/src/components/Icon/Icon.tsx b/src/components/Icon/Icon.tsx index 2aac11b4947..da9f57ea0a0 100644 --- a/src/components/Icon/Icon.tsx +++ b/src/components/Icon/Icon.tsx @@ -187,8 +187,10 @@ export interface Props { backdrop?: boolean; /** Descriptive text to be read to screenreaders */ accessibilityLabel?: string; - /** Render the icon in an img element instead of an svg to prevent cross-site scripting */ - /** @deprecated the untrusted prop is deprecated and will be removed (all raw strings passed into the Icon component will be assumed to be untrusted) */ + /** + * Render the icon in an img element instead of an svg to prevent cross-site scripting + * @deprecated the untrusted prop is deprecated and will be removed (all raw strings passed into the Icon component will be assumed to be untrusted) + */ untrusted?: boolean; }