Skip to content
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.

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

docs: add @deprecate to already deprecated components #4520

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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 packages/core/src/Box/Box.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const sxFn = (sx: HvBoxProps["sx"]) => {
* Customizable layout component that can be used to wrap other components.
* It can be used to add styles to the wrapped components.
* It can also be used to create a layout using the flexbox properties.
* @deprecated use native elements instead (e.g. `div`)
*/
export const HvBox = fixedForwardRef(function HvBox<
C extends React.ElementType = "div",
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/Focus/Focus.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ interface Focuses {
jump: Element;
}

/** @deprecated internal use only. this component has navigation issues. */
export const HvFocus = ({
classes: classesProp,
children,
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/Kpi/Kpi.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ export interface HvKpiProps extends HvBaseProps<HTMLDivElement, "children"> {
* Key Performance Indicator is a type of performance measurement. It monitors a business indicator
* and its success/failure against a given target. KPIs are the first item read on a dashboard.
* Communicates simple, immediate and vital information for operational decision making.
* @deprecated build KPIs with `HvCard`, or with your custom layouts
*/
export const HvKpi = (props: HvKpiProps) => {
const {
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/Link/Link.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ export interface HvLinkProps extends HvBaseProps<HTMLAnchorElement, "onClick"> {
classes?: HvLinkClasses;
}

/** @deprecated use `<HvTypography link component="a" />` instead */
export const HvLink = (props: HvLinkProps) => {
const {
onClick,
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/List/List.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ const DEFAULT_LABELS = {

/**
* Component used to show a set of related data to the user.
* @deprecated use `HvListContainer` + `HvListItem` instead
*/
export const HvList = (props: HvListProps) => {
const {
Expand Down
1 change: 1 addition & 0 deletions packages/core/src/hocs/withTooltip.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const styles: { truncate: React.CSSProperties } = {
},
};

/** @deprecated wrap your component with `HvTooltip` */
export const withTooltip =
(
Component: React.FunctionComponent,
Expand Down
Loading