Commit graph

97 commits

Author SHA1 Message Date
Marc Durdin
f55218fec6 chore: Merge remote-tracking branch 'origin/epic/web-core' into auto/A19S35-merge-base-into-web-core 2026-08-14 17:19:28 +02:00
Marc Durdin
1f82507730 docs(web): deprecate unused and obsolete API endpoints and docs cleanup
Deprecate the following obsolete functions and properties:
* `keyman.helpURL`
* `keyman.util.rgba`
* `keyman.util.toFloat`
* `keyman.util.toNumber`
* `keyman.util.toNzString`

Use correct language for code blocks in Keyman Engine for Web
documentation.

Test-bot: skip
2026-08-12 16:07:22 +02:00
Marc Durdin
b40c4b376b fix(web): cleanup loaduserinterface and unloaduserinterface events
The `loaduserinterface` and `unloaduserinterface` events were
incompletely implemented, and the documentation was incomplete. This
change:

1. ensures `loaduserinterface` is called any time a UI is set, either
   during initialization or when the property is set later.
2. ensures `unloaduserinterface` is called immediately before a UI is
   shutdown.
3. updates documentation
4. removes misleading commented code in kmwuifloat.ts

Test-bot: skip
2026-08-12 15:51:55 +02:00
Marc Durdin
f1361a94f0 feat(web): add keyman.versionInfo API
KeymanWeb has long had `keyman.build` and `keyman.version`. Neither of
these properties expose the full version string, and consumers are
forced to manipulate them to get a partial version string.

This change deprecates both these properties, and introduces a new
`keyman.versionInfo` property, which returns an object with all the
version information, most importantly `full`.

Update documentation and add a unit test for this, following the unit
test pattern established throughout Keyman of a unit test filename
matching the implementation class. The `KeymanEngineBase` class is a
little difficult to instantiate so this unit test module currently has
a minimal instantiation which provides enough to fulfill the one
included test.

Test-bot: skip
2026-08-12 11:07:31 +02:00
Eberhard Beilharz
58915062f8
docs(web): add language identifier to the code blocks of event docs
Build-bot: skip
Test-bot: skip
2026-08-10 14:17:56 +02:00
Eberhard Beilharz
0f16f39e17
chore: Merge branch 'epic/web-core' into auto/A19S33-merge-master-into-web-core 2026-07-20 09:57:23 +02:00
Marc Durdin
b25005b7db docs(web): fix typos following #16170
Test-bot: skip
Build-bot: skip
Follows: #16170
Co-authored-by: Eberhard Beilharz <ermshiperete@users.noreply.github.com>
2026-07-11 09:23:20 +02:00
Marc Durdin
0d8e6ae929
Merge pull request #16171 from keymanapp/docs/web/16169-cleanup
docs(web): cleanup of index pages and page titles
2026-07-11 17:14:59 +10:00
Marc Durdin
a1bd0987a8
Merge branch 'master' into fix/web/16144-define-interfaces-for-imes-in-base
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
2026-07-02 22:00:39 +10:00
Marc Durdin
d527e3739e docs(web): cleanup of index pages and page titles
Fixes: #16169
Test-bot: skip
2026-07-01 08:06:26 +02:00
Marc Durdin
0fc869faa4 fix(web): define IME interfaces in KeyboardInterfaceBase
Ensure that the IME interface methods are all defined for both browser
and webview modes. Deprecate 'Element' methods and replace with
'TextStore' to clarify return type. Add deprecation flags where needed
and update documentation accordingly.

Fixes: #16144
2026-07-01 07:43:08 +02:00
Eberhard Beilharz
bda4b50e2a
test(web): add e2e tests for examples from guide
Build-bot: skip build:web
Test-bot: skip
2026-06-18 19:43:12 +02:00
Eberhard Beilharz
623a73242c
Merge pull request #16086 from keymanapp/chore/web/cleanup
chore(web): remove outdated `*_load.js` files

This change removes unused `*_load.js` files and inlines the code from `laokeys_load.js`. Current Keyman versions no longer produce _load.js files when compiling a keyboard, so these files were pretty outdated.
2026-06-10 08:14:07 +02:00
Eberhard Beilharz
0539582012
Merge pull request #16085 from keymanapp/docs/web/keyman17
docs(web): remove unnecessary mentioning of Keyman 17 from docs

Some pages were mentioning Keyman 17 although the content applies to newer versions as well. This change therefore removes the version number from those places.
2026-06-10 08:13:38 +02:00
Eberhard Beilharz
9733ea4211
chore(web): remove outdated *_load.js files
This change removes unused `*_load.js` files and inlines the code from
`laokeys_load.js`. Current Keyman versions no longer produce _load.js
files when compiling a keyboard, so these files were pretty outdated.

Build-bot: skip build:web
Test-bot: skip
2026-06-09 18:42:47 +02:00
Eberhard Beilharz
52e6854d9f
Merge pull request #16070 from keymanapp/chore/web/improvedoc
chore(web): more improvements to documentation

- some small updates to the text
2026-06-09 18:19:00 +02:00
Eberhard Beilharz
a16e9b7f59
docs(web): remove unnecessary mentioning of Keyman 17 from docs
Some pages were mentioning Keyman 17 although the content applies to
newer versions as well. This change therefore removes the version
number from those places.

Build-bot: skip
Test-bot: skip
2026-06-09 18:16:59 +02:00
Eberhard Beilharz
517e9d26f3
Merge pull request #16064 from keymanapp/chore/web/449_rm_kmw
chore(web): improve the KeymanWeb integration documentation

- replace use of `kmw` with `keyman` 
- unify pattern to load keyboards: do it in `keyman.init().then()` instead   of in the document `onload`

Part-of: keymanapp/keyman.com#449
2026-06-09 18:08:15 +02:00
Eberhard Beilharz
1849286ace
chore(web): restore intended behavior of control-by-control example
Pending the fix for #16080.
2026-06-09 18:07:07 +02:00
Eberhard Beilharz
f697cffe58
chore(web): Merge branch 'chore/web/449_rm_kmw' into chore/web/improvedoc 2026-06-09 18:03:50 +02:00
Eberhard Beilharz
cea706c562
chore(web): address code review comments 2026-06-09 17:13:47 +02:00
Eberhard Beilharz
cf3d87d2f3
chore(web): update sample doc to match sample html
The guide examples load `keymanweb.js` from the CDN, but the documentation
explaining the examples showed loading local file. This change adjusts
the docs to show loading from CDN.

Built-bot: skip
Test-bot: skip
2026-06-09 17:11:58 +02:00
Eberhard Beilharz
135de352c4
Apply suggestions from code review
Co-authored-by: Marc Durdin <marc@durdin.net>
2026-06-09 17:11:43 +02:00
Eberhard Beilharz
c1113ac21d
chore(web): address code review comments
Some checks failed
Keyman Build Summary / Summarize build status checks (push) Has been cancelled
Also change a few places that I missed.
2026-06-08 19:27:12 +02:00
Eberhard Beilharz
15d020298e
Apply suggestions from code review
Co-authored-by: Marc Durdin <marc@durdin.net>
2026-06-08 18:14:25 +02:00
Eberhard Beilharz
f218aa92db
refactor(web): reformatting of files
Test-bot: skip
2026-06-03 19:51:44 +02:00
Eberhard Beilharz
d7439e68ac
chore(web): more improvements to documentation
- update text in `__control-by-control.html` sample
- some small updates to the text

Build-bot: skip
Test-bot: skip
2026-06-03 19:40:01 +02:00
Eberhard Beilharz
9ced04684a
chore(web): improve the KeymanWeb integration documentation
- replace use of `kmw` with `keyman`
- unify pattern to load keyboards: do it in `keyman.init().then()` instead
  of in the document `onload`

Part-of: keymanapp/keyman.com#449
Test-bot: skip
2026-06-03 19:37:08 +02:00
Marc Durdin
bd2a09a6c9 chore: Merge branch 'epic/web-core' into auto/A19S30-merge-master-into-web-core 2026-06-02 13:42:10 +02:00
Marc Durdin
9f75726344 chore(web): Merge branch 'master' into chore/web-core-preflight 2026-05-28 13:47:36 +02:00
Eberhard Beilharz
f61ad57544
refactor(web): don't wrap in the middle of links
Addresses code review comment.
2026-05-28 10:28:40 +02:00
Eberhard Beilharz
78ea935fe5
docs(web): reformat and small fixes
- rewrap lines
- change http:// to https://

Build-bot: skip
Test-bot: skip
2026-05-27 19:55:36 +02:00
Eberhard Beilharz
35ea65cde1
feat(web): get list of store names from stores defined in core
This implements `CoreKeyboardInterface.loadSerializedOptions` by getting
the list of all variable store names from Core and then trying to load
these.

Also change `VariableStoreSerializer.loadStore` signature so that it can
return `undefined`. This allows to return only those options from
`loadSerializedOptions` that have a non-default value, i.e. were
serialized before.

Build-bot: skip build:web
Test-bot: skip
2026-04-23 19:33:17 +02:00
Eberhard Beilharz
f22faa1c04
refactor(web): rename DefaultRulesDefaultOutputRules
Test-bot: skip
2026-01-16 17:11:28 +01:00
Marc Durdin
f6b8bfb463
Merge branch 'epic/web-core' into auto/A19S20-merge-master-into-web-core 2026-01-16 08:40:12 +01:00
Eberhard Beilharz
f8dbd6963b
Merge pull request #15313 from keymanapp/docs/web/fixtypo 2025-12-09 12:33:18 +01:00
Eberhard Beilharz
df806e10b6
docs(web): remove specific version from documentation
This removes the specific version from the control-by-control example
and thus makes it similar to the other examples where we use a relative
path. `get-started.md` and the *.html files will still show how this can
be done with a specific version.

Build-bot: skip
Test-bot: skip
2025-12-08 10:26:09 +01:00
Eberhard Beilharz
a18ad08a8f
docs(web): update version in documentation
Addresses a code review comment.
2025-12-08 10:20:00 +01:00
Eberhard Beilharz
4e291b8ef1
Update web/docs/engine/guide/get-started.md
Co-authored-by: Marc Durdin <marc@durdin.net>
2025-12-08 10:14:33 +01:00
Eberhard Beilharz
a1ec9371e6
docs(web): fix typo in osk documentation 2025-12-05 17:39:11 +01:00
Eberhard Beilharz
22c8a66731
docs(web): add links to next/previous page to web guide
Build-bot: skip
Test-bot: skip
2025-12-05 15:54:46 +01:00
Eberhard Beilharz
0fc7416b68
refactor(web): rename MockSyntheticTextStore 2025-11-04 17:14:37 +01:00
Eberhard Beilharz
c9fa02f21c
refactor(web): rename OutputTargetBaseTextStore 2025-11-04 16:58:08 +01:00
Keyman Server
744bd8fecc
Merge branch 'epic/web-core' into chore/A19S14-merge-master-into-web-core 2025-10-24 11:14:51 +02:00
Marc Durdin
d34f238eeb chore(web): update helpURL documentation and float ui link
Make the float UI KeymanWeb link point to the home for KeymanWeb, and
https rather than http, and update the helpURL documentation to match
the current endpoint.

Test-bot: skip
Build-bot: skip
2025-10-15 07:57:08 +02:00
Keyman Server
fb969f44a4
Merge branch 'epic/web-core' into chore/A19S11-merge-master-into-web-core 2025-09-12 00:26:19 -07:00
Eberhard Beilharz
8e65d13559
Merge pull request #14646 from keymanapp/refactor/common/13205_UnifyWhatsNew
Standardize on `whatsnew.md`.

Fixes: #13205
Related: https://github.com/keymanapp/help.keyman.com/pull/2234
2025-09-05 09:44:02 +02:00
Eberhard Beilharz
3e3cccc97d
Apply suggestions from code review
Co-authored-by: Darcy Wong <darcy_wong@sil.org>
2025-09-03 08:42:39 +02:00
Eberhard Beilharz
f166f11d14
docs(common): update docs Keyman Desktop → Keyman for Windows
Also change path to engine help pages. This requires a corresponding
change in help.keyman.com.

Test-bot: skip
2025-09-02 14:29:53 +02:00
Eberhard Beilharz
50950c6737
docs(web): Improve empty What's New page for Web
Build-bot: skip
Test-bot: skip
2025-09-01 17:39:21 +02:00