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.

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 JSDoc for StreamElement #1193

Merged
merged 1 commit into from
Jun 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 9 additions & 7 deletions src/elements/stream_element.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,22 @@ import { nextRepaint } from "../util"
/**
* Renders updates to the page from a stream of messages.
*
* Using the `action` attribute, this can be configured one of four ways:
* Using the `action` attribute, this can be configured one of eight ways:
*
* - `append` - appends the result to the container
* - `prepend` - prepends the result to the container
* - `replace` - replaces the contents of the container
* - `remove` - removes the container
* - `before` - inserts the result before the target
* - `after` - inserts the result after the target
* - `append` - appends the result to the target
* - `before` - inserts the result before the target
* - `prepend` - prepends the result to the target
* - `refresh` - initiates a page refresh
* - `remove` - removes the target
* - `replace` - replaces the outer HTML of the target
* - `update` - replaces the inner HTML of the target
*
* @customElement turbo-stream
* @example
* <turbo-stream action="append" target="dom_id">
* <template>
* Content to append to container designated with the dom_id.
* Content to append to target designated with the dom_id.
* </template>
* </turbo-stream>
*/
Expand Down