Skip to content

Commit

Permalink
chore: Clarify uses
Browse files Browse the repository at this point in the history
  • Loading branch information
darcywong00 committed Nov 24, 2023
1 parent 9be59f6 commit 2c254ce
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ Returns `true` if HTML assets were copied, `false` otherwise.

## Description
When suggestions aren't available for a keyboard, an HTML banner is displayed instead.
Use this method to specify any HTML assets the banner will use to theme your keyboard app.
Use this method to specify any HTML assets the banner will use to theme your keyboard app. Some examples of assets would be .svg images or .css files used in your banner.

This can be called towards the end of `SystemKeyboard.onCreate()`.

You still need to call [setHTMLBanner()](setHTMLBanner) for Keyman Engine to assign the HTML banner for in-app and system keyboards.

## Examples

### Example: Using `copyHTMLBannerAssets()`
Expand Down
4 changes: 3 additions & 1 deletion developer/engine/android/17.0/KMManager/setHTMLBanner.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ Returns `true` if HTML banner is set, `false` otherwise.
When suggestions aren't available for a keyboard, an HTML banner is displayed instead.
Use this method to specify the HTML content to display in the banner to theme your keyboard app.

Note: This needs to be updated whenever the keyboard is reloaded, so call this in `SystemKeyboard.onInitializeInterface(()`.
If the banner theme references assets (like .svg or .css files), ensure you've also called [copyHTMLBannerAssets()](copyHTMLBannerAssets).

Note: The HTML banner needs to be updated whenever the keyboard is reloaded, so call this in `SystemKeyboard.onInitializeInterface(()`.

## Examples

Expand Down

0 comments on commit 2c254ce

Please sign in to comment.