Skip to content

Commit

Permalink
document return type
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnC-80 committed Dec 10, 2024
1 parent c7cbabd commit fa20ad1
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is a NPM module to aid with embedding the Quill editor in [Stripes](https:/

## Value Sanitization

In any case where a user-created HTML string will be rendered directly to the UI, it should be sanitized to eliminate any issues with malformed tags/attributes. This library exports a `sanitize` function that should be used within the ui-module prior to passing the value to the form. The function accepts the value to be rendered and an optional overriding configuration for the sanitization library.
In any case where a user-created HTML string will be rendered directly to the UI, it should be sanitized to eliminate any issues with malformed tags/attributes. This library exports a `sanitize` function that should be used within the ui-module prior to passing the value to the form. The function accepts the value to be rendered and an optional overriding configuration for the sanitization library. It will return the sanitized string if any removals were necessary, otherwise it will return the original parameter value.

```
import { sanitize, TemplateEditor } from '@folio/stripes-template-editor'
Expand Down

0 comments on commit fa20ad1

Please sign in to comment.