Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

gobj-ui: Component gclasses

Component gclasses

Each component is a gclass, and each one needs its registration before an application creates an instance of it. Register them next to the gclasses of @yuneta/gobj-js, at start up.

import { register_c_yui_shell, register_c_yui_nav } from "@yuneta/gobj-ui";

register_c_yui_shell();
register_c_yui_nav();

The shell and the navigation

register_c_yui_shell()

C_YUI_SHELL draws the frame of the application from one JSON file: the toolbar, the menus and the zones. Its API is in The shell.

register_c_yui_nav()

C_YUI_NAV draws the menu of the shell. Each zone takes its own layout, and the layout changes with the width of the screen.

register_c_yui_pager()

C_YUI_PAGER holds a stack of pages inside one zone, for a movement that goes in and returns.

register_c_yui_wizard()

C_YUI_WIZARD drives a sequence of steps with a way forward and a way back.

register_c_yui_service_view()

C_YUI_SERVICE_VIEW puts a view of a service in a zone of the shell.

yui_mount_service_view(host, spec)

Puts a view of a service in a host, from a description of it.

expose_view_container(host, view)

Gives the container of a view to the host that holds it.


Windows

register_c_yui_window()

C_YUI_WINDOW draws a window that floats above the application.

register_c_yui_window_manager()

C_YUI_WINDOW_MANAGER holds the windows, and it draws the dock of them.


Data

register_c_yui_form()

C_YUI_FORM is the one engine of forms of the library. The attribute render_mode chooses between the form that runs a command and the form that edits a record.

register_c_yui_json()

C_YUI_JSON draws a JSON value, and it draws a big one without the cost of the whole tree.

register_c_yui_json_graph()

C_YUI_JSON_GRAPH draws a JSON value as a graph.

register_c_yui_period()

C_YUI_PERIOD chooses a range of time. Its calendar takes the language of the application. The algebra behind it is in Time and periods.


TreeDB

register_c_yui_treedb_topics()

C_YUI_TREEDB_TOPICS draws the topics of a treedb as cards, with a panel of information.

register_c_yui_treedb_graph()

C_YUI_TREEDB_GRAPH draws a treedb as the graph that it is: the topics are the nodes, and the links between hook and foreign key are the edges.

register_c_yui_treedb_schema()

C_YUI_TREEDB_SCHEMA draws the schema of a treedb.

register_c_yui_treedb_topic_with_form()

C_YUI_TREEDB_TOPIC_WITH_FORM draws one topic with the form of its records.

register_c_g6_nodes_tree()

C_G6_NODES_TREE draws a tree of nodes with the library G6.

register_c_yui_gobj_tree_js()

C_YUI_GOBJ_TREE_JS draws the tree of the gobjs of the application, for a development panel.


Charts and maps

register_c_yui_uplot()

C_YUI_UPLOT draws a chart of a series of time with the library uPlot.

register_c_yui_map()

C_YUI_MAP draws a map with the library maplibre. The controls are in Map controls.