Skip to content

withNotices: Convert to TypeScript #49088

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
mirka merged 4 commits into from
Mar 15, 2023
Merged

withNotices: Convert to TypeScript #49088

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef2c1bd
withNotices: Convert to TypeScript
mirka Mar 14, 2023
e894f4a
Make type exportable
mirka Mar 15, 2023
a6dac33
Add changelog
mirka Mar 15, 2023
0483ac2
Add `noticeList` to readme
mirka Mar 15, 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
Prev Previous commit
Add noticeList to readme
  • Loading branch information
@mirka
mirka committed Mar 15, 2023
commit 0483ac2dcc2d6291441edeae7bf9a72fc68acf61
5 changes: 4 additions & 1 deletion packages/components/src/higher-order/with-notices/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

`withNotices` is a React [higher-order component](https://facebook.github.io/react/docs/higher-order-components.html) used typically in adding the ability to post notice messages within the original component.

Wrapping the original component with `withNotices` encapsulates the component with the additional props `noticeOperations` and `noticeUI`.
Wrapping the original component with `withNotices` encapsulates the component with the additional props `noticeOperations`, `noticeUI`, and `noticeList`.

**noticeOperations**
Contains a number of useful functions to add notices to your site.
Expand Down Expand Up @@ -34,6 +34,9 @@ _Parameters_
<a name="noticeUi" href="#noticeUi">#</a>**noticeUi**
The rendered `NoticeList`.

<a name="noticeList" href="#noticeList">#</a>**noticeList**
The array of notice objects to be displayed.

## Usage

```jsx
Expand Down