# yuiKeyboardContract

A yui keyboard contract record carrying role, activationKeys, navigationKeys, escapeBehavior, pointerCommand, and related state.

Last updated: 2026-09-09

Package: ui | Status: source-declared

Tags: cpu, method, source-example, thing, ui, yeho

Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.

```yh
external thing yuiKeyboardContract
```

- text role: Stores role as text.
- text activationKeys: Stores activation keys as text.
- text navigationKeys: Stores navigation keys as text.
- text escapeBehavior: Stores escape behavior as text.
- text pointerCommand: Stores pointer command as text.
- text keyboardCommand: Stores keyboard command as text.
- yuiKeyboardContract(text role, text activationKeys, text navigationKeys, text escapeBehavior, text pointerCommand, text keyboardCommand): Yui keyboard contract.
- SemanticsMatch() returns bool: Semantics match.
- Describe() returns text: Describe.

## Use yuiKeyboardContract

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

Verification: type checked

```yh
using ui

// Build YUI's reusable control, layout, interaction, text, accessibility, and retained-rendering models.
yuiKeyboardContract sample = yuiKeyboardContract("role", "activation Keys", "navigation Keys", "escape Behavior", "pointer Command", "keyboard Command")
Console.Log(Text.From(sample.role))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuikeyboardcontract"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiKeyboardContract/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiKeyboardContract.SemanticsMatch

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Semantics match.
yuiKeyboardContract instance = yuiKeyboardContract("role", "activation Keys", "navigation Keys", "escape Behavior", "pointer Command", "keyboard Command")
bool result = instance.SemanticsMatch()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuikeyboardcontract"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiKeyboardContract/method-SemanticsMatch-7 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiKeyboardContract.Describe

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

Verification: type checked

```yh
using ui

// Describe.
yuiKeyboardContract instance = yuiKeyboardContract("role", "activation Keys", "navigation Keys", "escape Behavior", "pointer Command", "keyboard Command")
text result = instance.Describe()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuikeyboardcontract"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "graphics.image"
version = "0.1.0"
path = "../../../yeho/packages/graphics/image"

[[dependencies]]
package = "graphics.text"
version = "0.1.0"
path = "../../../yeho/packages/graphics/text"

[[dependencies]]
package = "host.ui_services"
version = "0.1.0"
path = "../../../yeho/packages/host/ui_services"

[[dependencies]]
package = "ui"
version = "0.2.0"
path = "../../../yeho/packages/ui"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/ui--yuiKeyboardContract/method-Describe-8 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

Source: yeho/packages/ui/interaction-commands.yh

AI training permission: https://demonhunterlabs.com/ai-use