docs(editor): move inputs, runtime events to legacy features#643
docs(editor): move inputs, runtime events to legacy features#643lancesnider merged 9 commits intomainfrom
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
| <Warning> | ||
| **DEPRECATION NOTICE:** This entire page documents the legacy Events system. | ||
| **For new projects:** Use [Data Binding](/runtimes/data-binding) instead. | ||
| **For existing projects:** Plan to migrate from Events to Data Binding as soon | ||
| as possible. **This content is provided for legacy support only.** | ||
| </Warning> |
There was a problem hiding this comment.
This isn't true. Events are still valid, just not for communicating with the runtime code.
ErikUggeldahl
left a comment
ErikUggeldahl
left a comment
There was a problem hiding this comment.
Some minor things to consider, mostly around clarity! Thanks for doing this.
|
@ErikUggeldahl I chatted with Hernan and Robert and ended up redoing a bunch of this. Most importantly, we're deprecating general events. 🎉 |
ErikUggeldahl
left a comment
ErikUggeldahl
left a comment
There was a problem hiding this comment.
Nits on casing and a comment about whether we want to allow URLs in the future. + perhaps we want to note that they won't be supported in new Android and Apple runtimes?
|
|
||
| For general information about adding, creating, and signaling events, see [Rive Events](/editor/events/overview). | ||
|
|
||
| ### URL Properties |
There was a problem hiding this comment.
As a note, this functionality was never added to the command queue, and so we have no way of responding to them. We need to consider as a team whether we want this functionality. Is it a security risk to allow Rive files to open arbitrary URLs? What if they point a user to a compromised website or a phishing scam?
There was a problem hiding this comment.
This was always more of a convenience as well. Developers could still react to a data binding event and open a browser using whatever native APIs are available to do that.
There was a problem hiding this comment.
For now I'm adding a warning about Apple/Android, but I can definitely see getting rid of these altogether.
They tend to confuse people at runtime because they're disabled by default and aren't supported in the marketplace or share links. You need to set property to make them work.
There was a problem hiding this comment.
3 big new warnings that scream "maybe don't use this". 😂
3 participants
Inputsout of the main nav, into theLegacy Featuresdropdown at the bottom of the sidebar.Eventspage says Events are deprecated, which they are not.Eventsinto 2 pages - one for valid events, one for the legacyEvents at runtimeThe
Eventspage still needs a lot of love, but this at least gets rid of incorrect info.