Document setState/getState in amp-script #24624
Conversation
|
/to @CrystalOnScript |
extensions/amp-script/amp-script.md
Outdated
| @@ -138,6 +138,51 @@ Will be reflected on the page as a new child of the `amp-script` element: | |||
|
|
|||
| Under the hood, `amp-script` uses [@ampproject/worker-dom](https://github.com/ampproject/worker-dom/). For design details, see the ["Intent to Implement" issue](https://github.com/ampproject/amphtml/issues/13471). | |||
|
|
|||
| ### Advanced usages | |||
There was a problem hiding this comment.
Are there other "advanced usages" coming? Are we unsupportive of this use case or is this a common request?
There was a problem hiding this comment.
There will most likely be more "advanced usages" in the future.
Right now, we think this is an interesting/unique capability of amp-script but it still needs more thought on how it can distill into concrete use cases.
There was a problem hiding this comment.
I vote for dropping "advanced usages" and titling this section as "State manipulation" or something similar.
There was a problem hiding this comment.
I wanted to highlight that it's kind of a niche use case since it requires the amp-bind extension to be installed too. There's already a lot of complex stuff in this documentation so being able to gloss over "Advanced usages" section might be useful. But I'll change it if you insist. :)
There was a problem hiding this comment.
I think advanced usages is a little misleading in that it makes it sound challenging rather than niche (although, is challenging misleading :P ?) and would make me believe it isn't a proper use case.
And please correct me if I'm wrong, but this use also sounds like a great way to support full page manipulation without wrapping the entire page in amp-script. Which may not be so niche?
extensions/amp-script/amp-script.md
Outdated
|
|
||
| `amp-script` supports getting and setting [`amp-state`](https://amp.dev/documentation/components/amp-bind/#initializing-state-with-amp-state) JSON via JavaScript. | ||
|
|
||
| This enables advanced interactions between `amp-script` and other AMP elements on the page via `amp-bind` [bindings](https://amp.dev/documentation/components/amp-bind/#bindings). |
There was a problem hiding this comment.
Does this enable amp-script to interact with elements outside of the <amp-script> tag?
There was a problem hiding this comment.
Indirectly yes, by modifying amp-state which can affect elements that have bindings.
Is the current phrasing too vague?
There was a problem hiding this comment.
After this sentence I would add:
"These elements can be inside or outside the amp-script tag."
There was a problem hiding this comment.
There's an edge case here: AMP elements inside amp-script doesn't really work well yet.
There was a problem hiding this comment.
Is this something we're working on? If not, should we advise developers to place AMP elements outside of amp-script?
There was a problem hiding this comment.
Added the suggested sentence.
|
@CrystalOnScript Cool to merge now? :) |
Add "Advanced usages" section that explains how to use
AMP.setStateandAMP.getStatein amp-script.