Skip to content

Commit 5ea91b0

Browse files
committed
feat: updated glossary to include modifiers and events
1 parent 230d30a commit 5ea91b0

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

src/content/docs/concepts/glossary.mdx

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Glossary
33
description: Definition of various terms in the context of the Vyuh Framework
44
---
55

6-
import { Aside } from '@astrojs/starlight/components'
6+
import { Aside, Badge } from '@astrojs/starlight/components'
77

88
## Descriptor
99

@@ -164,6 +164,13 @@ You can add your own actions and make them relevant to your app.
164164
> Like everything else in the _Vyuh Framework_, Action has counterparts on CMS
165165
> and on the Flutter side.
166166
167+
## Events
168+
169+
Events allow you to listen to lifecycle events that happen inside the framework.
170+
They can also be used by features to communicate with other features. The
171+
eventing system inside Vyuh acts like an event-bus where different features and
172+
plugins can communicate with each other with a type-safe event.
173+
167174
## Layout
168175

169176
Layouts describe the visual structure of a content-type. Every content type
@@ -173,6 +180,16 @@ other layouts. They are particularly useful for routes, and content types like
173180
_2-column grid_ is controlled by the layout. Layouts can be switched for
174181
different platforms, screen sizes, or based on runtime conditions.
175182

183+
## Modifier <sup><Badge text="New" /></sup>
184+
185+
Modifiers are chainable visual behaviors that can be attached to any
186+
content-item. You can have one or more Modifiers for a Content Item and are
187+
applied in the same order as specified.
188+
189+
The framework takes the output of the layout, which is a `Widget` and feeds it
190+
to the first modifier in the chain. The end output after applying all modifiers
191+
is also a `Widget`.
192+
176193
## Feature Registry
177194

178195
Feature Registry is a store of all the features that are available in the app.

0 commit comments

Comments
 (0)