# Bone Flow #117 Animation - HTML Class Guide

Version: 1.0.9

## 1. 目的

このClassはJavaScriptの `class {}` ではありません。HTML要素の `class=""` に機能Classを設定し、対応Public APIを宣言的に呼び出すためのClass契約です。

Public API function **21件 = HTML Class 21件** を1対1で対応させます。

## 2. Class共通引数契約

- `class="bone-..."`: 対応するPublic APIを指定。
- `data-bone-event`: `load` / `click` / `input` / `change` / `manual` 等。未指定は `load`。
- `data-bone-args`: Public APIの順番に並べたJSON配列。
- `data-bone-arg-N`: 0始まりの引数個別指定。
- `data-bone-once="true"`: DOMイベントを1回だけ処理。
- `data-bone-append-result="false"`: Element戻り値の自動appendを停止。
- `data-bone-throw="true"`: Error保存後にDebug用再throw。

### 特殊値

- `$self`: Classを設定したHTML要素そのものを渡します。element / target / root などの第1引数に使用します。
- `$event`: Class起動の原因になったDOM Eventを渡します。click / input / change等のイベント情報が必要なAPI用です。
- `$value`: input / textarea / select等の現在の value を渡します。
- `$checked`: checkbox / radio等の現在の checked(Boolean)を渡します。
- `$text`: Classを設定した要素の textContent を渡します。
- `$dataset`: Classを設定した要素の dataset を通常Objectとして渡します。
- `$files`: file input の FileList を渡します。
- `$selector:...`: ...をCSS selectorとして document.querySelector() で解決し、そのElementを渡します。
- `$id:...`: ...をDOM idとして document.getElementById() で解決し、そのElementを渡します。
- `$global:...`: window / globalThis上の指定名の値を渡します。
- `$handler:...`: window / globalThis上の指定名のFunctionをコールバック引数として渡します。

## 3. Result / State 契約

- `element.__boneClassResult`: 生の戻り値。
- `data-bone-class-status`: `ok` / `error`。
- `data-bone-class-result`: serializeした結果。
- `bone-html-class-result`: 成功CustomEvent。
- `bone-html-class-error`: 失敗CustomEvent。

## 4. Class一覧

### 1. `bone-animation-defaults`

- Public API: `BoneAnimation.defaults`
- 説明: BoneAnimation.defaults の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - 引数なし
- HTML例:

```html
<div class="bone-animation-defaults" data-bone-event="manual"></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 2. `bone-animation-normalize-options`

- Public API: `BoneAnimation.normalizeOptions`
- 説明: 設定をAnimationの正式契約に沿う形へ正規化します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: input` — API定義値 — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-normalize-options" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 3. `bone-animation-validate-options`

- Public API: `BoneAnimation.validateOptions`
- 説明: Animationの入力・状態を検証し、Validation結果を返します。
- 使用する場面: HTMLイベントから検証・解析を実行し、その結果をResultとして受け取りたいとき。
- 引数:
  - `0: input` — API定義値 — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-validate-options" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 4. `bone-animation-resolve-relation-key`

- Public API: `BoneAnimation.resolveRelationKey`
- 説明: BoneAnimation.resolveRelationKey の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: input` — API定義値 — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-resolve-relation-key" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 5. `bone-animation-duration-for-speed`

- Public API: `BoneAnimation.durationForSpeed`
- 説明: BoneAnimation.durationForSpeed の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: speed` — Number — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-duration-for-speed" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 6. `bone-animation-build-plan`

- Public API: `BoneAnimation.buildPlan`
- 説明: Animationで使用する出力・定義オブジェクトを構築します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: input` — API定義値 — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-build-plan" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 7. `bone-animation-create`

- Public API: `BoneAnimation.create`
- 説明: Animationの新しい要素またはRuntimeオブジェクトを生成します。
- 使用する場面: HTML上のホスト要素からUI生成・描画を開始したいとき。
- 引数:
  - `0: input` — API定義値 — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-create" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 8. `bone-animation-is-instance`

- Public API: `BoneAnimation.isInstance`
- 説明: 対象がAnimationの「Instance」条件を満たすか判定します。
- 使用する場面: JavaScriptを直接記述せず、HTML要素から現在値・状態・一覧を取得したいとき。
- 引数:
  - `0: value` — String / API許容値 — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-is-instance" data-bone-event="manual" data-bone-args='[null]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 9. `bone-animation-attach`

- Public API: `BoneAnimation.attach`
- 説明: BoneAnimation.attach の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
  - `1: target` — Element / Instance — `data-bone-arg-1` または `data-bone-args[1]`
  - `2: meta` — Object — `data-bone-arg-2` または `data-bone-args[2]`
- HTML例:

```html
<div class="bone-animation-attach" data-bone-event="manual" data-bone-args='["$self",null,{}]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 10. `bone-animation-update`

- Public API: `BoneAnimation.update`
- 説明: 既存のAnimation要素または状態を更新します。
- 使用する場面: HTMLのイベントを契機に、既存UIやRuntime状態を変更したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
  - `1: patch` — Object — `data-bone-arg-1` または `data-bone-args[1]`
- HTML例:

```html
<div class="bone-animation-update" data-bone-event="manual" data-bone-args='["$self",{}]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 11. `bone-animation-play`

- Public API: `BoneAnimation.play`
- 説明: BoneAnimation.play の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-play" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 12. `bone-animation-pause`

- Public API: `BoneAnimation.pause`
- 説明: BoneAnimation.pause の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-pause" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 13. `bone-animation-resume`

- Public API: `BoneAnimation.resume`
- 説明: BoneAnimation.resume の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-resume" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 14. `bone-animation-stop`

- Public API: `BoneAnimation.stop`
- 説明: BoneAnimation.stop の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-stop" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 15. `bone-animation-restart`

- Public API: `BoneAnimation.restart`
- 説明: BoneAnimation.restart の公開機能をHTML Classから呼び出します。
- 使用する場面: HTMLの class と data-bone-* 属性だけで対応Public APIを呼び出したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-restart" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 16. `bone-animation-get-state`

- Public API: `BoneAnimation.getState`
- 説明: Animationの「State」を取得します。
- 使用する場面: JavaScriptを直接記述せず、HTML要素から現在値・状態・一覧を取得したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-get-state" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 17. `bone-animation-get-output`

- Public API: `BoneAnimation.getOutput`
- 説明: Animationの「Output」を取得します。
- 使用する場面: JavaScriptを直接記述せず、HTML要素から現在値・状態・一覧を取得したいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
  - `1: source` — String / API許容値 — `data-bone-arg-1` または `data-bone-args[1]`
- HTML例:

```html
<div class="bone-animation-get-output" data-bone-event="manual" data-bone-args='["$self","html-class"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 18. `bone-animation-destroy`

- Public API: `BoneAnimation.destroy`
- 説明: Animationの対象インスタンスを破棄し、関連状態を解放します。
- 使用する場面: HTML操作を契機に対象の破棄・削除・切断・終了を行いたいとき。
- 引数:
  - `0: instance` — Element / Instance — `data-bone-arg-0` または `data-bone-args[0]`
- HTML例:

```html
<div class="bone-animation-destroy" data-bone-event="manual" data-bone-args='["$self"]'></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 19. `bone-animation-get-available-animations`

- Public API: `BoneAnimation.getAvailableAnimations`
- 説明: Animationの「Available Animations」を取得します。
- 使用する場面: JavaScriptを直接記述せず、HTML要素から現在値・状態・一覧を取得したいとき。
- 引数:
  - 引数なし
- HTML例:

```html
<div class="bone-animation-get-available-animations" data-bone-event="manual"></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 20. `bone-animation-get-formal-animations`

- Public API: `BoneAnimation.getFormalAnimations`
- 説明: Animationの「Formal Animations」を取得します。
- 使用する場面: JavaScriptを直接記述せず、HTML要素から現在値・状態・一覧を取得したいとき。
- 引数:
  - 引数なし
- HTML例:

```html
<div class="bone-animation-get-formal-animations" data-bone-event="manual"></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。

### 21. `bone-animation-get-flow-animations`

- Public API: `BoneAnimation.getFlowAnimations`
- 説明: Animationの「Flow Animations」を取得します。
- 使用する場面: JavaScriptを直接記述せず、HTML要素から現在値・状態・一覧を取得したいとき。
- 引数:
  - 引数なし
- HTML例:

```html
<div class="bone-animation-get-flow-animations" data-bone-event="manual"></div>
```

- Result: `__boneClassResult` / `data-bone-class-status` / `data-bone-class-result`。


## Safe activation marker

HTML Functional Class is active only when `bone-html-class-use` is present together with the API class. Example: `class="bone-html-class-use bone-..."`. This prevents existing presentation classes from being executed as APIs.