Skip to content

docs(editor): sidebar navigation reorganization #659

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

Merged
lancesnider merged 15 commits into from
May 13, 2026
Merged

docs(editor): sidebar navigation reorganization #659

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
5f7210f
docs(editor): move inputs, runtime events to legacy features
lancesnider Apr 30, 2026
a2db256
rewrite overview
lancesnider Apr 30, 2026
d0971d0
small wording change
lancesnider Apr 30, 2026
ce0dd00
Change to events at runtime
lancesnider Apr 30, 2026
322fd49
Merge branch 'main' into inputs-deprecated
lancesnider Apr 30, 2026
d8ce722
Merge branch 'main' into inputs-deprecated
lancesnider May 4, 2026
a99e5c2
wording change
lancesnider May 4, 2026
7992cd1
add dummy categories
lancesnider May 6, 2026
35cce28
conflicts
lancesnider May 6, 2026
e244c4a
move all links
lancesnider May 7, 2026
232362b
add wip landing page
lancesnider May 7, 2026
afb9ae1
conflicts
lancesnider May 7, 2026
b027d4e
remove getting started
lancesnider May 7, 2026
f302df4
More movin around
lancesnider May 7, 2026
2c06827
conflicts
lancesnider May 8, 2026
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
212 changes: 115 additions & 97 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,98 +88,112 @@
"editor/interface-overview/overview",
"editor/interface-overview/toolbar",
"editor/interface-overview/hierarchy",
"editor/tagging",
"editor/interface-overview/inspector",
"editor/interface-overview/stage"
"editor/interface-overview/stage",
"editor/keyboard-shortcuts",
"editor/fundamentals/design-vs-animate-mode"
]
},
}
]
},
{
"group": "Fundamentals",
"pages": [
{
"group": "Fundamentals",
"group": "Design",
"pages": [
"editor/fundamentals/overview",
"editor/fundamentals/design-vs-animate-mode",
"editor/fundamentals/artboards",
"editor/fundamentals/components",
"editor/fundamentals/pen-tool-overview",
"editor/fundamentals/shapes-and-paths-overview",
"editor/fundamentals/procedural-shapes",
"editor/fundamentals/groups",
"editor/fundamentals/selecting-and-navigating-groups",
"editor/fundamentals/transform-spaces",
"editor/fundamentals/fill-and-stroke",
"editor/fundamentals/edit-vertices",
"editor/fundamentals/freeze-and-origin",
"editor/fundamentals/importing-assets",
"editor/fundamentals/revision-history"
]
},
{
"group": "Manipulating Shapes",
"pages": [
"editor/manipulating-shapes/manipulating-shapes",
"editor/manipulating-shapes/bones",
"editor/manipulating-shapes/bone-tips",
"editor/manipulating-shapes/meshes",
"editor/manipulating-shapes/clipping",
"editor/manipulating-shapes/solos",
"editor/manipulating-shapes/trim-path",
"editor/manipulating-shapes/joysticks"
]
},
{
"group": "Text",
"pages": [
"editor/text/text-overview",
"editor/text/text-runs",
"editor/text/text-styles",
"editor/text/text-modifiers",
"editor/text/fonts"
{
"group": "Drawing",
"pages": [
"editor/fundamentals/shapes-and-paths-overview",
"editor/fundamentals/procedural-shapes",
"editor/fundamentals/pen-tool-overview",
"editor/fundamentals/fill-and-stroke",
"editor/fundamentals/edit-vertices",
"editor/manipulating-shapes/trim-path",
"editor/manipulating-shapes/clipping"
]
},
{
"group": "Text",
"pages": [
"editor/text/text-overview",
"editor/text/text-runs",
"editor/text/text-styles",
"editor/text/text-modifiers",
"editor/text/fonts"
]
},
{
"group": "Hierarchical Relationships",
"pages": [
"editor/fundamentals/groups",
"editor/fundamentals/selecting-and-navigating-groups",
"editor/manipulating-shapes/solos",
"editor/fundamentals/transform-spaces",
"editor/fundamentals/freeze-and-origin",
"editor/animate-mode/animating-draw-order"
]
},
{
"group": "Responsive Design",
"pages": [
"editor/layouts/layouts-overview",
"editor/layouts/layout-tools",
"editor/layouts/layout-parameters",
"editor/layouts/layout-styles",
"editor/layouts/layout-animation",
"editor/layouts/n-slicing",
"editor/layouts/scrolling"
]
}
]
},
{
"group": "Constraints",
"group": "Assets",
"pages": [
"editor/constraints/constraints-overview",
"editor/constraints/ik-constraint",
"editor/constraints/distance-constraint",
"editor/constraints/scale-constraint",
"editor/constraints/rotation-constraint",
"editor/constraints/transform-constraint",
"editor/constraints/translation-constraint",
"editor/constraints/follow-path-constraint",
"editor/constraints/scroll-constraint"
"editor/fundamentals/importing-assets",
"editor/libraries"
]
},
{
"group": "Animate Mode",
"group": "Animation",
"pages": [
"editor/animate-mode/animate-mode-overview",
"editor/animate-mode/timeline",
"editor/animate-mode/keys",
"editor/animate-mode/animation-mixing",
"editor/animate-mode/interpolation-easing",
"editor/animate-mode/animating-draw-order"
"editor/animate-mode/interpolation-easing"
]
},
{
"group": "State Machines",
"group": "Interaction",
"pages": [
"editor/state-machine/state-machine",
"editor/state-machine/states",
"editor/state-machine/transitions",
{
"group": "State Machines",
"pages": [
"editor/state-machine/state-machine",
"editor/state-machine/states",
"editor/state-machine/transitions",
"editor/state-machine/layers",
"editor/animate-mode/animation-mixing"
]
},
"editor/state-machine/listeners",
"editor/state-machine/layers"
]
},
{
"group": "Events",
"pages": [
"editor/events/overview",
"editor/events/open-url-events",
"editor/events/audio-events"
{
"group": "Events",
"pages": [
"editor/events/overview",
"editor/events/open-url-events",
"editor/events/audio-events"
]
}
]
},
{
"group": "Data Binding",
"group": "Data",
"pages": [
"editor/data-binding/overview",
{
Expand All @@ -196,41 +210,51 @@
]
},
{
"group": "Layouts",
"pages": [
"editor/layouts/layouts-overview",
"editor/layouts/layout-tools",
"editor/layouts/layout-parameters",
"editor/layouts/layout-styles",
"editor/layouts/layout-animation",
"editor/layouts/n-slicing",
"editor/layouts/scrolling"
]
},
{
"group": "Accessibility",
"group": "Publishing",
"pages": [
"editor/accessibility/semantics"
"editor/exporting/exporting-for-runtime",
"editor/exporting/exporting-for-video-and-static-design",
"editor/exporting/exporting-for-backup",
"editor/embed-urls/overview"
]
},
"editor/libraries",
"editor/keyboard-shortcuts",
}
]
},
{
"group": "Advanced Topics",
"pages": [
{
"group": "Exporting",
"group": "Rigging & Control",
"pages": [
"editor/exporting/exporting-for-runtime",
"editor/exporting/exporting-for-video-and-static-design",
"editor/exporting/exporting-for-backup"
"editor/manipulating-shapes/manipulating-shapes",
"editor/manipulating-shapes/bones",
"editor/manipulating-shapes/bone-tips",
"editor/manipulating-shapes/meshes",
"editor/manipulating-shapes/joysticks",
{
"group": "Constraints",
"pages": [
"editor/constraints/constraints-overview",
"editor/constraints/ik-constraint",
"editor/constraints/distance-constraint",
"editor/constraints/scale-constraint",
"editor/constraints/rotation-constraint",
"editor/constraints/transform-constraint",
"editor/constraints/translation-constraint",
"editor/constraints/follow-path-constraint",
"editor/constraints/scroll-constraint"
]
}
]
},
"editor/fundamentals/revision-history",
{
"group": "Embed URLs",
"group": "Accessibility",
"pages": [
"editor/embed-urls/overview"
"editor/accessibility/semantics"
]
},
"editor/ai-agent/ai-agent",
"editor/tagging",
{
"group": "Legacy Features",
"pages": [
Expand Down Expand Up @@ -429,12 +453,6 @@
"scripting/api-reference/mat2d/mat2d"
]
},
{
"group": "Mat4",
"pages": [
"scripting/api-reference/mat4/mat4"
]
},
{
"group": "Paint",
"pages": [
Expand Down
1 change: 1 addition & 0 deletions editor/animate-mode/animating-draw-order.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 'Animating Draw Order'
sidebarTitle: 'Draw Order'
description: ''
---

Expand Down
1 change: 0 additions & 1 deletion editor/data-binding/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Data Binding Overview"
sidebarTitle: "Overview"
description: "Connect editor elements to data and code using View Models"
---

Expand Down
2 changes: 1 addition & 1 deletion editor/embed-urls/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Embed URLs Overview'
sidebarTitle: 'Overview'
sidebarTitle: 'Embed URLs'
description: 'Embed URLs are a fast, no-code way to share or embed your Rive files on the web.'
---

Expand Down
26 changes: 13 additions & 13 deletions editor/events/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { YouTube } from "/snippets/youtube.mdx";

Events live within an artboard and are used to signal that something has happened. They can be fired from timelines, states, transitions, or listeners.

Rive supports three types of events:
Rive supports three types of Events:

- [Open URL Event](/editor/events/open-url-events) — Opens a URL at runtime
- [Audio Event](/editor/events/audio-events) — Plays a sound
Expand All @@ -17,26 +17,26 @@ Rive supports three types of events:

<Steps>
<Step title="Create an Event">
Use the Events tool located in the toolbar and click anywhere on the artboard.
Use the Events tool located in the Toolbar and click anywhere on the artboard.

![Adding a new event](https://ucarecdn.com/4ed6c563-4c59-42c8-b40c-f502d5a8e1a4/)

You'll notice that the event is displayed on the artboard and in the Hierarchy.
You'll notice that the Event is displayed on the artboard and in the Hierarchy.
</Step>
<Step title="Name your Event">
Give your event a name so it’s easy to identify and reference.

You can rename it using the **Name** field, or by double-clicking the name directly on the artboard.

![Renaming an event](https://ucarecdn.com/4558fb61-4649-4210-9ec6-c828c48ab2b2/)
![Renaming an Event](https://ucarecdn.com/4558fb61-4649-4210-9ec6-c828c48ab2b2/)
</Step>
<Step title="Select an Event type">
The Type dropdown allows you to change the event type between Audio, URL, and General.
The Type dropdown allows you to change the Event type between Audio, URL, and General.

![Image](https://ucarecdn.com/9621c007-de2e-428c-95d7-837615a37caa/)
</Step>
<Step title="Set your Event Properties">
Each event type has its own set of properties.
Each Event type has its own set of properties.

For more information on the specific event types, see [Open URL Events](/editor/events/open-url-events), [Audio Events](/editor/events/audio-events), and [General Events (deprecated)](/editor/events/general-events).
</Step>
Expand All @@ -45,27 +45,27 @@ Rive supports three types of events:

## Signaling an Event

We can signal an event in four ways: from a timeline, a listener, a state, or a transition.
We can signal an Event in four ways: from a timeline, a listener, a state, or a transition.

### Timeline

Signaling an event from the timeline lets you control the exact moment in an animation when the event fires.
Signaling an Event from the timeline lets you control the exact moment in an animation when the Event fires.

First, select the timeline you want to add the event to. Then use the **Report Event** button in the Inspector.
First, select the timeline you want to add the Event to. Then use the **Report Event** button in the Inspector.

![Keying an Event on the timeline](https://ucarecdn.com/bd8d36f9-9cd1-4eec-9c37-85d4a0a19643/)

### Transition & State

You can report an event on a transition or a state. To report an event, select the desired state or transition and use the `+` button next to the Events section in the Inspector.
You can report an event on a Transition or a State. To report an event, select the desired State or Transition and use the `+` button next to the Events section in the Inspector.


![Signaling an event via state or transition](https://ucarecdn.com/d1a63666-0cce-408f-9364-826eed66b241/)
![Signaling an Event via State or Transition](https://ucarecdn.com/d1a63666-0cce-408f-9364-826eed66b241/)

Now that we've selected the event, we can decide whether it is signaled at the start or end of the transition or state.
Now that we've selected the Event, we can decide whether it is signaled at the start or end of the Transition or State.

### Listeners

With your [Listener](/editor/state-machine/listeners) selected, click the `+` below the State Machine Graph, and select **Report Event**.

![Trigger an event with a listener](/images/editor/events/trigger-events-with-listeners.gif)
![Trigger an Event with a listener](/images/editor/events/trigger-events-with-listeners.gif)
2 changes: 1 addition & 1 deletion editor/layouts/layouts-overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Overview'
sidebarTitle: 'Overview'
sidebarTitle: 'Layouts Overview'
description: 'Layouts allow you to build responsive UI components in Rive. Make your designs fit, fill, or reflow content based on the space available.'
---

Expand Down
Loading