Skip to content

fix: Remove wrong deprecated tag on flashbar interfaces #673

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
Jan 26, 2023
Merged

fix: Remove wrong deprecated tag on flashbar interfaces #673

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
350f039
fix: Remove wrong deprecated tag on flashbar interfaces
Jan 26, 2023
0238f7c
chore: Update deprecation notice for buttonText
Jan 26, 2023
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: 2 additions & 2 deletions src/__tests__/__snapshots__/documenter.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5545,7 +5545,6 @@ Object {
"type": "string",
},
Object {
"deprecatedTag": "Replaced by \`action\`.",
"description": "Specifies flash messages that appear in the same order that they are listed.
The value is an array of flash message definition objects.
A flash message object contains the following properties:
Expand All @@ -5563,7 +5562,8 @@ user's attention.
* \`action\` (ReactNode) - Specifies an action for the flash message. Although it is technically possible to insert any content,
our UX guidelines only allow you to add a button.
* \`buttonText\` (string) - Specifies that an action button should be displayed, with the specified text.
When a user clicks on this button the \`onButtonClick\` handler is called. If the \`action\` property is set, this property is ignored.
When a user clicks on this button the \`onButtonClick\` handler is called.
If the \`action\` property is set, this property is ignored. **Deprecated**, replaced by \`action\`.
* \`onButtonClick\` (event => void) - Called when a user clicks on the action button. This is not called if you create a custom button
using the \`action\` property. **Deprecated**, replaced by \`action\`.
* \`id\` (string) - Specifies a unique flash message identifier. This property is used in two ways:
Expand Down
4 changes: 2 additions & 2 deletions src/flashbar/interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,14 @@ export interface FlashbarProps extends BaseComponentProps {
* * `action` (ReactNode) - Specifies an action for the flash message. Although it is technically possible to insert any content,
* our UX guidelines only allow you to add a button.
* * `buttonText` (string) - Specifies that an action button should be displayed, with the specified text.
* When a user clicks on this button the `onButtonClick` handler is called. If the `action` property is set, this property is ignored.
* When a user clicks on this button the `onButtonClick` handler is called.
* If the `action` property is set, this property is ignored. **Deprecated**, replaced by `action`.
* * `onButtonClick` (event => void) - Called when a user clicks on the action button. This is not called if you create a custom button
* using the `action` property. **Deprecated**, replaced by `action`.
* * `id` (string) - Specifies a unique flash message identifier. This property is used in two ways:
* 1. As a [keys](https://reactjs.org/docs/lists-and-keys.html#keys) source for React rendering.
* 2. To identify which flash message will be removed from the DOM when it is dismissed, to animate it out.
*
* @deprecated Replaced by `action`.
* @visualrefresh `id` property
*/
items: ReadonlyArray<FlashbarProps.MessageDefinition>;
Expand Down