Skip to content

Commit 95d0868

Browse files
committed
link to docs in readme
1 parent 10f139e commit 95d0868

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,27 @@ _in active development_
66
![using input tracking](https://storage.googleapis.com/creatability-github/creatability-maher.gif)
77

88

9+
10+
## Components
11+
12+
* [`<acc-button>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_button_.buttonelement.html) - standard button
13+
* [`<acc-content>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_content_.contentelement.html) - a container for main content. Easily pairs with inputs such as `<acc-pose-input>` and displays webcam for using body as cursor input.
14+
* [`<acc-group>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_group_.groupelement.html) - a group of UI controls
15+
* [`<acc-input-mode-select>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_input_mode_select_.inputmodeselectelement.html) - used to select the current input method (i.e. mouse/keyboard/touch or body pose).
16+
* [`<acc-item>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_item_.itemelement.html) - data used to populate an `<acc-select>` dropdown or an `<acc-radio-group>`.
17+
* [`<acc-mouse-input>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_mouse_input_.mouseinputelement.html) - an input that combines mouse/keyboard/touch into one normalized input.
18+
* [`<acc-optgroup>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_optgroup_.optgroupelement.html) - similar to `<optgroup>` a method of nesting within an `<acc-select>`
19+
* [`<acc-pose-input>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_pose_input_.poseinputelement.html) - an element providing easy tracking of a selected body part to use as a cursor input.
20+
* `<acc-radio-group>` - a group of radio buttons
21+
* [`<acc-range>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_range_.rangeelement.html) - a slider / range element
22+
* [`<acc-select>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_select_.selectelement.html) - a select / dropdown element
23+
* [`<acc-side-panel>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_side_panel_.sidepanel.html) - collapsable panel that you can place UI components in, also includes tabbable "skip to content" shortcut.
24+
* `<acc-slide>` - data to use as a slide within `<acc-slideshow>`
25+
* [`<acc-slideshow>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_slideshow_.slideshowelement.html) - a slideshow with next/previous navigation
26+
* [`<acc-snackbar>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_snackbar_.snackbarelement.html) - a floating temporary UI notification system. Ideal for use with ARIA-LIVE.
27+
* [`<acc-toggle>`](https://googlecreativelab.github.io/creatability-components/docs/api/classes/_components_toggle_.toggleelement.html) - similar to a checkbox
28+
29+
930
## Usage
1031

1132
A simple example of including the library then supporting mouse/keyboard and body tracking inputs.

0 commit comments

Comments
 (0)