# yuiRetainedKeyIndex

A yui retained key index record carrying bucketCount, bucketHeads, keys, values, nextNodes, 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 yuiRetainedKeyIndex
```

- int bucketCount: Stores bucket count as int.
- list of int bucketHeads: Stores bucket heads as list of int.
- list of text keys: Stores keys as list of text.
- list of int values: Stores values as list of int.
- list of int nextNodes: Stores next nodes as list of int.
- int keyComparisons: Stores key comparisons as int.
- yuiRetainedKeyIndex(int bucketCount): Yui retained key index.
- Bucket(text key) returns int: Bucket.
- Find(text key) returns int: Find.
- Set(text key, int value): Set.

## Use yuiRetainedKeyIndex

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.
yuiRetainedKeyIndex sample = yuiRetainedKeyIndex(1)
Console.Log(Text.From(sample.bucketCount))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiretainedkeyindex"
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--yuiRetainedKeyIndex/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiRetainedKeyIndex.Bucket

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

Verification: type checked

```yh
using ui

// Bucket.
yuiRetainedKeyIndex instance = yuiRetainedKeyIndex(1)
text argument_key = "argument key"
int result = instance.Bucket(argument_key)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiretainedkeyindex"
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--yuiRetainedKeyIndex/method-Bucket-7 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiRetainedKeyIndex.Find

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

Verification: type checked

```yh
using ui

// Find.
yuiRetainedKeyIndex instance = yuiRetainedKeyIndex(1)
text argument_key = "argument key"
int result = instance.Find(argument_key)
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiretainedkeyindex"
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--yuiRetainedKeyIndex/method-Find-8 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## yuiRetainedKeyIndex.Set

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

Verification: type checked

```yh
using ui

// Set.
yuiRetainedKeyIndex instance = yuiRetainedKeyIndex(1)
text argument_key = "argument key"
int argument_value = 1
instance.Set(argument_key, argument_value)
Console.Log("Set completed")

```

Save this beside start.yh as project.mech:

```toml
manifestVersion = "2"
package = "api.example.ui__yuiretainedkeyindex"
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--yuiRetainedKeyIndex/method-Set-9 --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/render-50-retained-fragments.yh

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