json_component

A json to flutter widget component interpreter

Getting Started

Create component

/// A component that will build a text widget
class TextComponent extends BaseJsonComponent {
    /// Component can have additional field
    final String data;

    /// Need to call super to store common `_id`,`key`, and `_state`
    TextComponent.fromJson(super.json)
        : data = json['data'],
          super.fromJson();

    @override
    Widget build(BuildContext context, ComponentContext: cContext) {
        /// This is how the component will be built on render
        return Text(data);
    }
}

Register component

/// Component need to be registered to be work, componentId need to be unique per component
JsonComponent.register(componentId, TextComponent.fromJson);

Using component

class SomeClass extends StatelessWidget {
    ...

    @override
    Widget build(BuildContext context) {
        return ...(
            ...
            /// Need to pass json of the component into `JsonComponent.build`
            child: JsonComponent.build(...)
        )

Component JSON Structure

Updating state

    ...
    /// This state will be concated with previous state
    JsonComponent.setState(key, state);

Using state in component

On the json component we can use state by putting $state. on the value, example:

{
    "_id": "text",
    "_key": "title-component-key",
    "_state": {
        "value": "Initial Text",
        "nested": {
            "variable": "sample"
        }
    },
    "data": "$state.value" /// Initial Text
    "otherData": "$state.nested.variable" /// sample
}

Then on the component you can use the data with .withContext(...) to translate the key into real value.

class TextComponent extends BaseJsonComponent {
    ...

    @override
    Widget build(BuildContext context, ComponentContext: cContext) {
        return Text(data.withContext(cContext)); /// Example of translating pattern to state value
    }
    
    ...
}

*if there is no matched pattern, it will return the key as is

Example

• WIP

Maintainers

• Heri Setiawan