├── .github └── workflows │ ├── android.yml │ ├── auto-author-assign.yml │ ├── dependent-issues.yml │ └── rebase-default-branch.yml ├── .gitignore ├── .idea └── copyright │ ├── Editor_copyright.xml │ └── profiles_settings.xml ├── LICENSE ├── README.md ├── assets ├── android-sample.png └── infomaniak-mail.webp ├── build.gradle.kts ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── jitpack.yml ├── rich-html-editor ├── .gitignore ├── build.gradle.kts ├── proguard-rules.pro └── src │ └── main │ ├── assets │ ├── attach_listeners.js │ ├── define_listeners.js │ ├── editor_template.html │ ├── focus_request.js │ ├── link_detection.js │ └── manage_links.js │ └── java │ └── com │ └── infomaniak │ └── lib │ └── richhtmleditor │ ├── DocumentInitializer.kt │ ├── EditorReloader.kt │ ├── EditorStatuses.kt │ ├── Extensions.kt │ ├── JsBridge.kt │ ├── JsColor.kt │ ├── Justification.kt │ ├── RichHtmlEditorWebView.kt │ ├── RichHtmlEditorWebViewClient.kt │ ├── StatusCommand.kt │ ├── Utils.kt │ └── executor │ ├── HtmlSetter.kt │ ├── JsExecutableMethod.kt │ ├── JsExecutor.kt │ ├── JsLifecycleAwareExecutor.kt │ ├── KeyboardOpener.kt │ ├── ScriptCssInjector.kt │ ├── SpellCheckHtmlSetter.kt │ └── StateSubscriber.kt ├── sample ├── .gitignore ├── build.gradle.kts ├── proguard-rules.pro └── src │ └── main │ ├── AndroidManifest.xml │ ├── assets │ ├── editor_custom_css.css │ ├── example1.html │ └── example2.html │ ├── java │ └── com │ │ └── infomaniak │ │ └── lib │ │ └── richhtmleditor │ │ └── sample │ │ ├── EditorSampleFragment.kt │ │ ├── EditorSampleViewModel.kt │ │ └── MainActivity.kt │ └── res │ ├── color │ └── background_editor_button.xml │ ├── drawable │ ├── ic_indent.xml │ ├── ic_justify_center.xml │ ├── ic_justify_full.xml │ ├── ic_justify_left.xml │ ├── ic_justify_right.xml │ ├── ic_launcher_background.xml │ ├── ic_launcher_foreground.xml │ ├── ic_ordered_list.xml │ ├── ic_outdent.xml │ ├── ic_redo.xml │ ├── ic_subscript.xml │ ├── ic_superscript.xml │ ├── ic_undo.xml │ └── ic_unordered_list.xml │ ├── layout │ ├── activity_main.xml │ ├── create_link_text_input.xml │ └── fragment_editor_sample.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.xml │ ├── mipmap-hdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-mdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── navigation │ └── nav_graph.xml │ ├── values-night │ ├── colors.xml │ └── themes.xml │ ├── values-v23 │ └── themes.xml │ ├── values │ ├── colors.xml │ ├── dimens.xml │ ├── strings.xml │ ├── style.xml │ └── themes.xml │ └── xml │ ├── data_extraction_rules.xml │ └── network_security_config.xml └── settings.gradle.kts /.github/workflows/android.yml: -------------------------------------------------------------------------------- 1 | name: Android CI 2 | 3 | on: 4 | pull_request: 5 | 6 | concurrency: 7 | group: ${{ github.head_ref }} 8 | cancel-in-progress: true 9 | 10 | jobs: 11 | 12 | instrumentation-tests: 13 | if: github.event.pull_request.draft == false 14 | runs-on: [ self-hosted, Android ] 15 | strategy: 16 | matrix: 17 | api-level: [ 34 ] 18 | target: [ google_apis ] 19 | 20 | steps: 21 | - name: Cancel Previous Runs 22 | uses: styfle/cancel-workflow-action@0.12.1 23 | with: 24 | access_token: ${{ github.token }} 25 | 26 | - name: Checkout the code 27 | uses: actions/checkout@v4.1.1 28 | with: 29 | token: ${{ github.token }} 30 | submodules: recursive 31 | 32 | # Setup Gradle and run Build 33 | - name: Grant execute permission for gradlew 34 | run: chmod +x gradlew 35 | - name: Build with Gradle 36 | run: ./gradlew build 37 | 38 | # Run tests 39 | - name: Run Unit tests 40 | run: ./gradlew testDebugUnitTest --stacktrace 41 | -------------------------------------------------------------------------------- /.github/workflows/auto-author-assign.yml: -------------------------------------------------------------------------------- 1 | name: Auto Author Assign 2 | 3 | on: 4 | pull_request_target: 5 | types: [ opened, reopened ] 6 | 7 | permissions: 8 | pull-requests: write 9 | 10 | jobs: 11 | assign-author: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: toshimaru/auto-author-assign@v2.1.0 15 | -------------------------------------------------------------------------------- /.github/workflows/dependent-issues.yml: -------------------------------------------------------------------------------- 1 | name: Dependent Issues 2 | 3 | on: 4 | issues: 5 | types: 6 | - opened 7 | - edited 8 | - closed 9 | - reopened 10 | pull_request_target: 11 | types: 12 | - opened 13 | - edited 14 | - closed 15 | - reopened 16 | # Makes sure we always add status check for PRs. Useful only if 17 | # this action is required to pass before merging. Otherwise, it 18 | # can be removed. 19 | - synchronize 20 | 21 | jobs: 22 | check: 23 | runs-on: ubuntu-latest 24 | steps: 25 | - uses: z0al/dependent-issues@v1.5.2 26 | env: 27 | # (Required) The token to use to make API calls to GitHub. 28 | GITHUB_TOKEN: ${{ github.token }} 29 | -------------------------------------------------------------------------------- /.github/workflows/rebase-default-branch.yml: -------------------------------------------------------------------------------- 1 | # GitHub Actions Virtual Environments 2 | # https://github.com/actions/virtual-environments/ 3 | 4 | # Rebases a pull request on the repo's default branch when the "rebase" label is added 5 | # Note: you'll need to add a personal access token to your repo, `PERSONAL_ACCESS_TOKEN`. (`REBASE_PR_TOKEN`) 6 | # Link: https://github.com/jessesquires/gh-workflows/blob/main/.github/workflows/rebase-default-branch.yml 7 | 8 | name: Rebase Pull Request 9 | 10 | on: 11 | pull_request: 12 | types: [ labeled ] 13 | 14 | env: 15 | DEFAULT_BRANCH: ${{ github.event.repository.default_branch }} 16 | 17 | jobs: 18 | main: 19 | if: ${{ contains(github.event.*.labels.*.name, 'rebase') }} 20 | name: Rebase 21 | runs-on: ubuntu-latest 22 | steps: 23 | - name: git checkout 24 | uses: actions/checkout@v3 25 | with: 26 | token: ${{ secrets.REBASE_PR_TOKEN }} 27 | ref: ${{ github.event.pull_request.head.ref }} 28 | fetch-depth: 0 29 | 30 | # Link: https://httgp.com/signing-commits-in-github-actions/ 31 | - name: Import bot's GPG key for signing commits 32 | id: import-gpg 33 | uses: crazy-max/ghaction-import-gpg@v4 34 | with: 35 | gpg_private_key: ${{ secrets.BOT_GPG_PRIVATE_KEY }} 36 | passphrase: ${{ secrets.BOT_GPG_PASSPHRASE }} 37 | git_config_global: true 38 | git_user_signingkey: true 39 | git_commit_gpgsign: true 40 | 41 | - name: perform rebase 42 | run: | 43 | git config --global user.email "kevin.boulongne+bot@gmail.com" 44 | git status 45 | git pull 46 | git checkout "$DEFAULT_BRANCH" 47 | git status 48 | git pull 49 | git checkout "$GITHUB_HEAD_REF" 50 | git rebase "$DEFAULT_BRANCH" 51 | git push --force-with-lease 52 | git status 53 | 54 | # Link: https://github.com/marketplace/actions/actions-ecosystem-remove-labels 55 | - name: remove label 56 | if: always() 57 | uses: actions-ecosystem/action-remove-labels@v1 58 | with: 59 | labels: rebase 60 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Gradle files 2 | .gradle/ 3 | build/ 4 | 5 | # Local configuration file (sdk path, etc) 6 | local.properties 7 | 8 | # Log/OS Files 9 | *.log 10 | 11 | # Android Studio generated files and folders 12 | captures/ 13 | .externalNativeBuild/ 14 | .cxx/ 15 | *.apk 16 | *.aab 17 | output.json 18 | 19 | # IntelliJ 20 | *.iml 21 | .idea/ 22 | misc.xml 23 | deploymentTargetDropDown.xml 24 | render.experimental.xml 25 | 26 | # Keystore files 27 | *.jks 28 | *.keystore 29 | 30 | # Google Services (e.g. APIs or Firebase) 31 | google-services.json 32 | 33 | # Android Profiling 34 | *.hprof 35 | 36 | # Missing gitignore compared to mail 37 | .DS_Store 38 | -------------------------------------------------------------------------------- /.idea/copyright/Editor_copyright.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 7 | -------------------------------------------------------------------------------- /.idea/copyright/profiles_settings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Infomaniak Rich HTML Editor 2 | 3 | ![JitPack](https://jitpack.io/v/Infomaniak/android-rich-html-editor.svg) 4 | 5 | The **Infomaniak Rich HTML Editor** is an Android library designed to display HTML and easily modify it on the fly. It relies on 6 | the power of the `contenteditable` HTML attribute inside a WebView. 7 | 8 | 9 | Android sample app 10 | 11 | Looking for an iOS or macOS equivalent? Check out the Swift version of this editor here: [Infomaniak/swift-rich-html-editor](https://github.com/Infomaniak/swift-rich-html-editor) 12 | 13 | ## ✍️ About 14 | 15 | ### Features 16 | 17 | - **HTML Content Editing**: Full support for viewing and editing HTML content directly. 18 | - **Wide range of formatting commands**: Many commands are available to format text, from simple commands like bold to more 19 | advanced ones like link creation. 20 | - **Useful API to control the editor**: It lets you: 21 | - Listen to format option's activated status when the cursor moves around the html content 22 | - Add custom css to the editor 23 | - Add custom scripts to the editor 24 | 25 | ### Installation 26 | 27 | Add this dependency to your project: 28 | 29 | Using version catalog: 30 | 31 | ```toml 32 | rich-html-editor = { module = "com.github.infomaniak:android-rich-html-editor", version.ref = "richHtmlEditorVersion" } 33 | ``` 34 | 35 | Directly inside gradle dependencies: 36 | 37 | ```gradle 38 | dependencies { 39 | implementation "com.github.Infomaniak:android-rich-html-editor:$richHtmlEditorVersion" 40 | } 41 | ``` 42 | 43 | The latest version is: ![JitPack](https://jitpack.io/v/Infomaniak/android-rich-html-editor.svg) 44 | 45 | ## ⚙️ Usage 46 | 47 | ### Simplest usage 48 | 49 | In your layout: 50 | 51 | ```xml 52 | 56 | ``` 57 | 58 | In your fragment: 59 | 60 | ```kt 61 | val html = """ 62 | 63 | 64 |

Hello World

65 | 66 | 67 | """.trimMargin() 68 | editor.setHtml(html) 69 | ``` 70 | 71 | ### Change format and reacte to its changes 72 | 73 | Add a button to your xml: 74 | 75 | ```xml 76 |