Skip to content

Commit 218d965

Browse files
authored
docs(Toolbar): replace deprecation annotation with a note (#5101)
1 parent c7c6469 commit 218d965

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

packages/main/src/components/Toolbar/index.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,11 @@ export interface ToolbarPropTypes extends Omit<CommonProps, 'onClick' | 'childre
126126
const OVERFLOW_BUTTON_WIDTH = 36 + 8 + 8; // width + padding end + spacing start
127127

128128
/**
129+
*
130+
* __Note:__ The `Toolbar` component may be replaced by the `ui5-toolbar` web-component (currently available as `ToolbarV2`) with our next major release. If you only need to pass components supported by `ToolbarV2` then please consider using `ToolbarV2` instead of this component.
131+
*
132+
* ___
133+
*
129134
* Horizontal container most commonly used to display buttons, labels, selects and various other input controls.
130135
*
131136
* The content of the `Toolbar` moves into the overflow area from right to left when the available space is not enough in the visible area of the container.
@@ -134,8 +139,6 @@ const OVERFLOW_BUTTON_WIDTH = 36 + 8 + 8; // width + padding end + spacing start
134139
* __Note:__ The overflow popover is mounted only when the overflow button is displayed, i.e., any child component of the popover will be remounted, when moved into it.
135140
*
136141
* __Note:__ To prevent duplicate child `id`s in the DOM, all child `id`s get an `-overflow` suffix. This is especially important when popovers are opened by id.
137-
*
138-
* @deprecated This component will be replaced by the `ui5-toolbar` web-component (currently available as `ToolbarV2`) with our next major release. Please use `ToolbarV2` instead.
139142
*/
140143
const Toolbar = forwardRef<HTMLDivElement, ToolbarPropTypes>((props, ref) => {
141144
const {

packages/main/src/components/ToolbarSeparator/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export type ToolbarSeparatorPropTypes = CommonProps;
2222
/**
2323
* Creates a visual separator between the preceding and succeeding `Toolbar` item.
2424
*
25-
* @deprecated This component is only compatible with the deprecated `Toolbar` component and __not__ with `ToolbarV2`. If you're using `ToolbarV2`, please use `ToolbarSeparatorV2` instead.
25+
* __Note:__ This component is only compatible with the `Toolbar` component and __not__ with `ToolbarV2`. If you're using `ToolbarV2`, please use `ToolbarSeparatorV2` instead.
2626
*/
2727
const ToolbarSeparator = forwardRef<HTMLDivElement, ToolbarSeparatorPropTypes>((props, ref) => {
2828
const { style, className, ...rest } = props;

packages/main/src/components/ToolbarSpacer/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export type ToolbarSpacerPropTypes = CommonProps;
55
/**
66
* Adds horizontal space between the items used within a `Toolbar`.
77
*
8-
* @deprecated This component is only compatible with the deprecated `Toolbar` component and __not__ with `ToolbarV2`. If you're using `ToolbarV2`, please use `ToolbarSpacerV2` instead.
8+
* __Note:__ This component is only compatible with the `Toolbar` component and __not__ with `ToolbarV2`. If you're using `ToolbarV2`, please use `ToolbarSpacerV2` instead.
99
*/
1010
const ToolbarSpacer = forwardRef<HTMLSpanElement, ToolbarSpacerPropTypes>((props, ref) => {
1111
return <span ref={ref} style={{ flexGrow: 1 }} className="spacer" {...props} />;

0 commit comments

Comments
 (0)