Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update autoadvancetoggle component styleguidist docs #398

Merged
merged 2 commits into from
Feb 9, 2024
Merged

Update autoadvancetoggle component styleguidist docs #398

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a232b92
Update autoadvancetoggle component styleguidist docs
Feb 8, 2024
b2df57d
Update src/components/AutoAdvanceToggle/AutoAdvanceToggle.md
Dananji Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/components/AutoAdvanceToggle/AutoAdvanceToggle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
AutoAdvanceToggle description
AutoAdvanceToggle component provides the ability to turn on/off auto-advance from a Canvas to the next when viewing a IIIF Manifest. It reads the `behavior` property at the Manifest-level, and then parses and stores the given values to a Boolean flag within Ramp's state management.

When `behavior` is not specified in the Manifest, this is set to not auto-advance as the default temporal behavior if not specified is `no-auto-advance` per the [IIIF Presentation 3.0 specification](https://iiif.io/api/presentation/3.0/#behavior).
Dananji marked this conversation as resolved.
Show resolved Hide resolved

`AutoAdvanceToggle` component allows the following props;
- `label`: accepts a String value, which has a default value of '`Autoplay`' and is _not required_. This allows to customize the label for the toggle.
Expand Down