Package index

Dock Board

A board class that includes dock layout information and board extension object.

new_dock_board() is_dock_board() as_dock_board() dock_extensions() `dock_extensions<-`() dock_ext_ids() extension_ids() dock_board_options()

Dock board

new_dock_stack() is_dock_stack() stack_color() suggest_new_colors() `stack_color<-`() as_dock_stack()

Colored stacks

Dock layout

Tools for defining panel arrangements.

dock_grid() panels() group() default_layout()

Dock grid authoring

Dock grid

A view’s geometry in canonical form.

as_dock_grid() is_dock_grid() validate_dock_grid()

Canonical view grid

Dock layout boundary

dockView’s native layout representation, the wire form at the client boundary.

new_dock_layout() is_dock_layout() validate_dock_layout() as_dock_layout()

Dock layout: dockView's native representation

Panel IDs

The canonical panel IDs a grid or layout references.

panel_obj_ids() layout_panel_ids()

Panel IDs of a grid or layout

Panel references

Typed references to block and extension panels for the update grammar.

blk() ext() is_panel_ref() as_panel_ref() as.character(<panel_ref>)

Typed panel references

Dock views

Multi-view (tabbed) boards. Each view is its own panel arrangement.

is_dock_grids() validate_dock_grids() board_grids() `board_grids<-`() as_dock_view() dock_view() is_dock_view() validate_dock_view() view_members() is_dock_views() validate_dock_views() view_name() `view_name<-`() view_names() active_view() `active_view<-`() board_views() `board_views<-`()

Dock views: structure and grid

Board extensions

Board extensions allow for adding components that interact with and modify board state.

new_dock_extension() is_dock_extension() validate_extension() extension_ui() extension_server() extension_id() extension_name() extension_ctor() new_dock_extensions() is_dock_extensions() validate_extensions() as_dock_extensions() extension_block_callback()

Dock extensions

new_ext_meta() is_ext_meta() ext_meta() ext_desc() ext_args() ext_examples() ext_guidance() extension_description()

Extension metadata

new_edit_board_extension()

Edit board extension

Board actions

Actions are intended as re-usable, narrowly scoped board interactions, such as adding or removing a block.

new_action() is_action() is_action_generator() action_id() board_actions() action_triggers() block_input_select() block_registry_selectize() board_select()

Board actions

Utilities

Various utility functions that are exported for use in dependent packages.

blks_metadata() blk_color() blk_icon_data_uri() block_status_badge()

Get block metadata

dock_id() is_dock_panel_id() as_dock_panel_id() as_obj_id() is_block_panel_id() as_block_panel_id() is_ext_panel_id() as_ext_panel_id() as_dock_handle_id() as_block_handle_id() as_ext_handle_id() as_view_handle_id()

ID utilities