Skip to content

Commit

Permalink
feat: updated glossary to include modifiers and events
Browse files Browse the repository at this point in the history
  • Loading branch information
pavanpodila committed Dec 8, 2024
1 parent 230d30a commit 5ea91b0
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion src/content/docs/concepts/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Glossary
description: Definition of various terms in the context of the Vyuh Framework
---

import { Aside } from '@astrojs/starlight/components'
import { Aside, Badge } from '@astrojs/starlight/components'

## Descriptor

Expand Down Expand Up @@ -164,6 +164,13 @@ You can add your own actions and make them relevant to your app.
> Like everything else in the _Vyuh Framework_, Action has counterparts on CMS
> and on the Flutter side.
## Events

Events allow you to listen to lifecycle events that happen inside the framework.
They can also be used by features to communicate with other features. The
eventing system inside Vyuh acts like an event-bus where different features and
plugins can communicate with each other with a type-safe event.

## Layout

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

## Modifier <sup><Badge text="New" /></sup>

Modifiers are chainable visual behaviors that can be attached to any
content-item. You can have one or more Modifiers for a Content Item and are
applied in the same order as specified.

The framework takes the output of the layout, which is a `Widget` and feeds it
to the first modifier in the chain. The end output after applying all modifiers
is also a `Widget`.

## Feature Registry

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

0 comments on commit 5ea91b0

Please sign in to comment.