A transparent discovery signal based on current public GitHub metadata.
Recent activity35% weight
72
Community adoption25% weight
27
Maintenance state20% weight
85
License clarity10% weight
100
Project information10% weight
75
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
README preview
Infomaniak Rich HTML Editor
The Infomaniak Rich HTML Editor is an Android library designed to display HTML and easily modify it on the fly. It relies on
the power of the contenteditable HTML attribute inside a WebView.
To modify the library, don't forget to update the api.txt file with metalava's gradle task ./gradlew metalavaGenerateSignatureRelease
Features
HTML Content Editing: Full support for viewing and editing HTML content directly.
Wide range of formatting commands: Many commands are available to format text, from simple commands like bold to more
advanced ones like link creation.
Useful API to control the editor: It lets you:
Listen to format option's activated status when the cursor moves around the html content
Set a click listener on the button to apply the associated format and modify the appearance of the button to report the status
where the cursor is placed:
boldButton.setOnClickListener { editor.toggleBold() }
viewLifecycleOwner.lifecycleScope.launch {
editor.editorStatusesFlow.collect {
// Update your button's activation status how you prefer. If you have provided
// an activated state color for your button, you can do the following:
boldButton.isActivated = it.isBold
}
}
[!TIP]
If you want to listen to the status changes of a format, do not forget to subscribe to it as described in the following
Subscribe to format states section.
Subscribe to format states
You can subscribe only to the states that are relevant to you. This way, the flow will update its value only when at least one of
your subscribed states changes.
[!NOTE]
By default, when subscribeToStates() is never called, all available StatusCommand will be subscribed to.
You can subscribe to all possible states by passing in null
editor.subscribeToStates(null)
Add custom css or script to the editor
You can add your own css to stylize your editor to your liking or you can add scripts to develop your own advanced
functionalities. To do so, the editor exposes two easy to use methods.
Execute JavaScript after all the editor and its scripts are set up
You might want to define some custom scripts that exposes functions for you to call later on in your logic. If you need to make
sure the script is loaded before calling its methods, use executeJsMethodWhenEditorIsSetup()
// When setting up the editor add a script that will be loaded inside the <head>
editor.addScript(
"""
function setBackground(color) {
document.body.style['background'] = color
}
""".trimIndent()
)
// When you need to execute the method from the above script inside some logic or button click
editor.executeJsMethodWhenEditorIsSetup(JsExecutableMethod("setBackground", "#00FFFF"))
Use a custom WebViewClient with the editor
To safely use your own WebViewClient instance with the editor, you have to call the
RichHtmlEditorWebView's notifyPageHasLoaded() inside your custom WebViewClient's onPageFinished() callback.
Activate/Deactivate spellcheck
Spellcheck is activated by default but if you don't want to have any spellcheck done on the editor content,
you can do that by doing so.
Acces the editor element inside the DOM
If you need to access the editor inside your custom javascript code, you can call the globally available getEditor() method.
This is the prefered way over trying to access the div of the editor by its ID directly.
Retreive user selection
If you need to retrieve the user selection inside the editor, you can call the getSelectedText method.
This returns the selected text in a String. If the user didn't select anything, an empty string will be returned.
