erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
spiegel-keyman/developer/docs/help/reference/api/kmc-kmn.osk.stringresult.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.1 KiB
Raw Blame History

Home > @keymanapp/kmc-kmn > Osk > StringResult

Osk.StringResult interface

Represents a single key cap found by AnalyzeOskCharacterUse

Signature:

export interface StringResult

Properties

Property Modifiers Type Description
pua string hexadecimal single character in PUA range, without 'U+' prefix, e.g. 'F100'
str string the key cap string
unicode string unicode code points in for reference, without 'U+' prefix, e.g. '0061 0301'
usages StringRefUsage[] | string[] files in which the string is referenced; will be an array of if includeCounts is true, otherwise will be an array of strings listing files in which the key cap may be found