Skip to content

Commit a913663

Browse files
authored
chore(chrome): deprecate Chrome components (#2047)
1 parent 25a029f commit a913663

File tree

8 files changed

+18
-0
lines changed

8 files changed

+18
-0
lines changed

packages/chrome/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
Collection of elements relating to the Chrome component within the Garden Design System
44

5+
| ⚠️ **DEPRECATED** |
6+
| :------------------------------------------------------------------------------------------------------------- |
7+
| The `Chrome` components (including `Body`, `Content`, `Header`, `Main`, `Nav`) are deprecated for general use. |
8+
59
## Installation
610

711
```sh

packages/chrome/src/elements/Chrome.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ import { ChromeContext } from '../utils/useChromeContext';
1515
import { StyledChrome } from '../styled';
1616

1717
/**
18+
* @deprecated no longer for general use
19+
*
1820
* @extends HTMLAttributes<HTMLDivElement>
1921
*/
2022
export const Chrome = React.forwardRef<HTMLDivElement, IChromeProps>(

packages/chrome/src/elements/body/Body.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import { StyledBody } from '../../styled';
1010
import { BodyContext } from '../../utils/useBodyContext';
1111

1212
/**
13+
* @deprecated no longer for general use
14+
*
1315
* @extends HTMLAttributes<HTMLDivElement>
1416
*/
1517
export const Body = React.forwardRef<HTMLDivElement, HTMLAttributes<HTMLDivElement>>(

packages/chrome/src/elements/body/Content.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import { StyledContent } from '../../styled';
1010
import { useBodyContext } from '../../utils/useBodyContext';
1111

1212
/**
13+
* @deprecated no longer for general use
14+
*
1315
* @extends HTMLAttributes<HTMLDivElement>
1416
*/
1517
export const Content = React.forwardRef<HTMLDivElement, HTMLAttributes<HTMLDivElement>>(

packages/chrome/src/elements/body/Main.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ import React, { HTMLAttributes } from 'react';
99
import { StyledMain } from '../../styled';
1010

1111
/**
12+
* @deprecated no longer for general use
13+
*
1214
* @extends HTMLAttributes<HTMLElement>
1315
*/
1416
export const Main = React.forwardRef<HTMLElement, HTMLAttributes<HTMLElement>>((props, ref) => (

packages/chrome/src/elements/footer/Footer.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ export const FooterComponent = React.forwardRef<HTMLElement, HTMLAttributes<HTML
3636
FooterComponent.displayName = 'Footer';
3737

3838
/**
39+
* @deprecated no longer for general use
40+
*
3941
* @extends HTMLAttributes<HTMLElement>
4042
*/
4143
export const Footer = FooterComponent as typeof FooterComponent & {

packages/chrome/src/elements/header/Header.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ HeaderComponent.propTypes = {
2727
};
2828

2929
/**
30+
* @deprecated no longer for general use
31+
*
3032
* @extends HTMLAttributes<HTMLElement>
3133
*/
3234
export const Header = HeaderComponent as typeof HeaderComponent & {

packages/chrome/src/elements/nav/Nav.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ NavComponent.propTypes = {
4444
};
4545

4646
/**
47+
* @deprecated no longer for general use
48+
*
4749
* @extends HTMLAttributes<HTMLElement>
4850
*/
4951
export const Nav = NavComponent as typeof NavComponent & {

0 commit comments

Comments
 (0)