diff --git a/packages/chrome/README.md b/packages/chrome/README.md index 477a3f1643c..d4ebe250aca 100644 --- a/packages/chrome/README.md +++ b/packages/chrome/README.md @@ -2,6 +2,10 @@ Collection of elements relating to the Chrome component within the Garden Design System +| ⚠️ **DEPRECATED** | +| :------------------------------------------------------------------------------------------------------------- | +| The `Chrome` components (including `Body`, `Content`, `Header`, `Main`, `Nav`) are deprecated for general use. | + ## Installation ```sh diff --git a/packages/chrome/src/elements/Chrome.tsx b/packages/chrome/src/elements/Chrome.tsx index 877fb949023..904f3720352 100644 --- a/packages/chrome/src/elements/Chrome.tsx +++ b/packages/chrome/src/elements/Chrome.tsx @@ -15,6 +15,8 @@ import { ChromeContext } from '../utils/useChromeContext'; import { StyledChrome } from '../styled'; /** + * @deprecated no longer for general use + * * @extends HTMLAttributes */ export const Chrome = React.forwardRef( diff --git a/packages/chrome/src/elements/body/Body.tsx b/packages/chrome/src/elements/body/Body.tsx index 24c18514ec7..80024e4d033 100644 --- a/packages/chrome/src/elements/body/Body.tsx +++ b/packages/chrome/src/elements/body/Body.tsx @@ -10,6 +10,8 @@ import { StyledBody } from '../../styled'; import { BodyContext } from '../../utils/useBodyContext'; /** + * @deprecated no longer for general use + * * @extends HTMLAttributes */ export const Body = React.forwardRef>( diff --git a/packages/chrome/src/elements/body/Content.tsx b/packages/chrome/src/elements/body/Content.tsx index 016d34f8736..144d9eff782 100644 --- a/packages/chrome/src/elements/body/Content.tsx +++ b/packages/chrome/src/elements/body/Content.tsx @@ -10,6 +10,8 @@ import { StyledContent } from '../../styled'; import { useBodyContext } from '../../utils/useBodyContext'; /** + * @deprecated no longer for general use + * * @extends HTMLAttributes */ export const Content = React.forwardRef>( diff --git a/packages/chrome/src/elements/body/Main.tsx b/packages/chrome/src/elements/body/Main.tsx index 0b1a2a72f50..50e2a011c9e 100644 --- a/packages/chrome/src/elements/body/Main.tsx +++ b/packages/chrome/src/elements/body/Main.tsx @@ -9,6 +9,8 @@ import React, { HTMLAttributes } from 'react'; import { StyledMain } from '../../styled'; /** + * @deprecated no longer for general use + * * @extends HTMLAttributes */ export const Main = React.forwardRef>((props, ref) => ( diff --git a/packages/chrome/src/elements/footer/Footer.tsx b/packages/chrome/src/elements/footer/Footer.tsx index 9c9e7d1d048..cd266ad31cb 100644 --- a/packages/chrome/src/elements/footer/Footer.tsx +++ b/packages/chrome/src/elements/footer/Footer.tsx @@ -36,6 +36,8 @@ export const FooterComponent = React.forwardRef */ export const Footer = FooterComponent as typeof FooterComponent & { diff --git a/packages/chrome/src/elements/header/Header.tsx b/packages/chrome/src/elements/header/Header.tsx index 8d576feb5af..595f753ca99 100644 --- a/packages/chrome/src/elements/header/Header.tsx +++ b/packages/chrome/src/elements/header/Header.tsx @@ -27,6 +27,8 @@ HeaderComponent.propTypes = { }; /** + * @deprecated no longer for general use + * * @extends HTMLAttributes */ export const Header = HeaderComponent as typeof HeaderComponent & { diff --git a/packages/chrome/src/elements/nav/Nav.tsx b/packages/chrome/src/elements/nav/Nav.tsx index 77fd61f92c0..482d1b1fed9 100644 --- a/packages/chrome/src/elements/nav/Nav.tsx +++ b/packages/chrome/src/elements/nav/Nav.tsx @@ -44,6 +44,8 @@ NavComponent.propTypes = { }; /** + * @deprecated no longer for general use + * * @extends HTMLAttributes */ export const Nav = NavComponent as typeof NavComponent & {