GPUI.Schema (gpui v0.2.0-rc.1)

Copy Markdown View Source

Canonical element, component, event, resource, and style protocol schema.

Summary

Functions

apply_defaults(assigns, tag)
component!(tag)
component_options_doc(tag)

Returns generated public option documentation for a component tag.

components()
defaults(tag)
define_component_option_types(definitions)

Defines public component option types from schema definitions.

events()
extension(id)

Returns one schema-owned presentation contract by ID.

extensions()

Returns all schema-owned versioned presentation contracts.

identified_tags()
native_tags()

Returns every renderer-native schema tag in declaration order.

registry()

Returns an immutable registry containing neutral core declarations.

registry(modules)

Returns a composed registry for explicitly selected schema modules.

resource_specs()
resources()
stateful_components()
style_specs()
styles()
tags()
validate_component_assigns!(assigns, tag_or_component, extra_attrs \\ [])

Functions

apply_defaults(assigns, tag)

component!(tag)

component_options_doc(tag)

@spec component_options_doc(atom()) :: String.t()

Returns generated public option documentation for a component tag.

components()

defaults(tag)

define_component_option_types(definitions)

(macro)

Defines public component option types from schema definitions.

events()

extension(id)

@spec extension(atom()) :: GPUI.Schema.Extension.t()

Returns one schema-owned presentation contract by ID.

extensions()

@spec extensions() :: [GPUI.Schema.Extension.t()]

Returns all schema-owned versioned presentation contracts.

identified_tags()

native_tags()

Returns every renderer-native schema tag in declaration order.

registry()

@spec registry() :: GPUI.Schema.Registry.t()

Returns an immutable registry containing neutral core declarations.

registry(modules)

@spec registry([module()]) :: GPUI.Schema.Registry.t()

Returns a composed registry for explicitly selected schema modules.

resource_specs()

resources()

stateful_components()

style_specs()

styles()

tags()

validate_component_assigns!(assigns, tag_or_component, extra_attrs \\ [])

@spec validate_component_assigns!(map(), atom() | GPUI.Schema.Component.t(), [atom()]) ::
  map()