Skip to content

Commit

Permalink
chore: updated comment on blocks rendered to identify need to extend … (
Browse files Browse the repository at this point in the history
#747)

Update of comment block when using the ksesAllowedList in BlocksRenderer
to explain the need to extend the core allowed list.

### Changelog Entry
> Fixed - Comment update


### Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you are unsure about any of these, please ask for
clarification. We are here to help! -->
- [ ] I agree to follow this project's [**Code of
Conduct**](https://github.com/10up/.github/blob/trunk/CODE_OF_CONDUCT.md).
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my change.
- [ ] All new and existing tests pass.
  • Loading branch information
nicholasio authored Apr 11, 2024
2 parents baae872 + 1ed197d commit 29d45a2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions packages/core/src/react/components/BlocksRenderer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ export interface BlockRendererProps {
html: string;

/**
* The allow list for the parser
* The allow list for the parser, must extend the core allowed list
*
* ```jsx
* <BlocksRenderer
* html="<div><p>hello world</p> div content</div>"
* ksesAllowList={{ div: [] }}
* html="<div some-attribute><p>hello world</p> div content</div>"
* ksesAllowList={{ { ...ksesAllowedList, div: [...ksesAllowedList.div, 'some-attribute'] }, }}
* />,
* ```
*/
Expand Down

0 comments on commit 29d45a2

Please sign in to comment.