How To Use CleanSpeak Guard
1. Install the plugin in your Bubble app.

2. Add the CleanSpeak Guard element to the page where you want to check text.

3. Choose how you want to check text.

For direct text checking, set the plugin’s Text field to your input’s value, for example: Input Comment's value.

For real-time checking, set Watch Realtime to yes and add a Target Selector, for example: #comment-input input.

To use a Target Selector, first enable Bubble’s ID attributes by going to Settings > General > Expose the option to add an ID attribute to HTML elements. Then give your input an ID, such as comment-input.

4. Set the Strictness Level.

Light checks basic profanity and mild insults. Medium checks stronger insults, NSFW terms, and more abusive language. Harsh is the strictest level and checks slurs, hate terms, threats, self-harm phrases, and severe explicit terms.

5. Choose a Replacement Mode.

Censor replaces unsafe words with your Replacement Text, such as ****.

Safe word replaces unsafe words with cleaner alternatives.

First letter keeps the first letter and masks the rest.

6. Optional: add Custom Words.

Use Custom Words to block extra words or phrases. You can enter words separated by commas or line breaks.

Example: customword, another bad phrase

7. Optional: add Allowed Words.

Use Allowed Words for terms that should not be filtered, even if they look similar to blocked words.

Example: sex education, breast cancer

8. Optional: use Detection Only mode.

Turn on Detection Only if you want to check text without changing it. This is useful when you want to block a form submission instead of editing the user’s text.

9. Use plugin states in your workflows.

Available states include Clean Text, Original Text, Is Clean, Match Count, and Matches.

Example workflow: Only when CleanSpeak Guard's Is Clean is yes -> Create a new Comment.

Example workflow: Only when CleanSpeak Guard's Is Clean is no -> Show an alert asking the user to clean up their message.

10. Use the Check text now action when needed.

Run the Check text now action when you want to manually check text from a workflow instead of relying only on real-time checking.

11. Use the Sanitize text server-side action when you want returned workflow values.

The server-side action returns Original Text, Clean Text, Is Clean, Match Count, and Matches. Use this when you want to check or sanitize text before saving it to the database.