Skip to content

chore(chrome): deprecate Chrome components #2047

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
Sep 9, 2025
Merged

chore(chrome): deprecate Chrome components #2047

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
7cc3f82
chore(chrome): deprecate `Chrome` components
jzempel Sep 8, 2025
9316ea7
Remove `SkipNav` from deprecation
jzempel Sep 8, 2025
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
4 changes: 4 additions & 0 deletions packages/chrome/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/Chrome.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import { ChromeContext } from '../utils/useChromeContext';
import { StyledChrome } from '../styled';

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLDivElement>
*/
export const Chrome = React.forwardRef<HTMLDivElement, IChromeProps>(
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/body/Body.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import { StyledBody } from '../../styled';
import { BodyContext } from '../../utils/useBodyContext';

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLDivElement>
*/
export const Body = React.forwardRef<HTMLDivElement, HTMLAttributes<HTMLDivElement>>(
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/body/Content.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import { StyledContent } from '../../styled';
import { useBodyContext } from '../../utils/useBodyContext';

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLDivElement>
*/
export const Content = React.forwardRef<HTMLDivElement, HTMLAttributes<HTMLDivElement>>(
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/body/Main.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import React, { HTMLAttributes } from 'react';
import { StyledMain } from '../../styled';

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLElement>
*/
export const Main = React.forwardRef<HTMLElement, HTMLAttributes<HTMLElement>>((props, ref) => (
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/footer/Footer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ export const FooterComponent = React.forwardRef<HTMLElement, HTMLAttributes<HTML
FooterComponent.displayName = 'Footer';

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLElement>
*/
export const Footer = FooterComponent as typeof FooterComponent & {
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/header/Header.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ HeaderComponent.propTypes = {
};

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLElement>
*/
export const Header = HeaderComponent as typeof HeaderComponent & {
Expand Down
2 changes: 2 additions & 0 deletions packages/chrome/src/elements/nav/Nav.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ NavComponent.propTypes = {
};

/**
* @deprecated no longer for general use
*
* @extends HTMLAttributes<HTMLElement>
*/
export const Nav = NavComponent as typeof NavComponent & {
Expand Down