Raxol.Protocols (Raxol v2.0.1)

Convenience module for importing all unified protocols.

Summary

Functions

apply_style(component, style)

See Raxol.Protocols.CoreProtocols.Component.apply_style/2.

cleanup(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.cleanup/1.

clear(buffer, region)

See Raxol.Protocols.CoreProtocols.BufferOperations.clear/2.

deserialize(data, format, target_type)

See Raxol.Protocols.CoreProtocols.Serializable.deserialize/3.

get_config(configurable)

See Raxol.Protocols.CoreProtocols.Configurable.get_config/1.

get_default_config(configurable)

See Raxol.Protocols.CoreProtocols.Configurable.get_default_config/1.

get_dimensions(buffer)

See Raxol.Protocols.CoreProtocols.BufferOperations.get_dimensions/1.

get_metadata(component)

See Raxol.Protocols.CoreProtocols.Component.get_metadata/1.

get_schema(data)

See Raxol.Protocols.CoreProtocols.Serializable.get_schema/1.

get_state(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.get_state/1.

handle_event(component, event, state)

See Raxol.Protocols.CoreProtocols.Component.handle_event/3.

initialize(component, opts)

See Raxol.Protocols.CoreProtocols.Lifecycle.initialize/2.

merge_config(configurable, config)

See Raxol.Protocols.CoreProtocols.Configurable.merge_config/2.

read(buffer, position)

See Raxol.Protocols.CoreProtocols.BufferOperations.read/2.

render(component, opts)

See Raxol.Protocols.CoreProtocols.Component.render/2.

resize(buffer, width, height)

See Raxol.Protocols.CoreProtocols.BufferOperations.resize/3.

restart(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.restart/1.

scroll(buffer, direction, amount)

See Raxol.Protocols.CoreProtocols.BufferOperations.scroll/3.

serialize(data, format)

See Raxol.Protocols.CoreProtocols.Serializable.serialize/2.

set_config(configurable, config)

See Raxol.Protocols.CoreProtocols.Configurable.set_config/2.

start(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.start/1.

stop(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.stop/1.

validate(component)

See Raxol.Protocols.CoreProtocols.Component.validate/1.

validate_config(configurable, config)

See Raxol.Protocols.CoreProtocols.Configurable.validate_config/2.

write(buffer, position, data)

See Raxol.Protocols.CoreProtocols.BufferOperations.write/3.

Functions

apply_style(component, style)

See Raxol.Protocols.CoreProtocols.Component.apply_style/2.

cleanup(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.cleanup/1.

clear(buffer, region)

See Raxol.Protocols.CoreProtocols.BufferOperations.clear/2.

deserialize(data, format, target_type)

See Raxol.Protocols.CoreProtocols.Serializable.deserialize/3.

get_config(configurable)

See Raxol.Protocols.CoreProtocols.Configurable.get_config/1.

get_default_config(configurable)

See Raxol.Protocols.CoreProtocols.Configurable.get_default_config/1.

get_dimensions(buffer)

See Raxol.Protocols.CoreProtocols.BufferOperations.get_dimensions/1.

get_metadata(component)

See Raxol.Protocols.CoreProtocols.Component.get_metadata/1.

get_schema(data)

See Raxol.Protocols.CoreProtocols.Serializable.get_schema/1.

get_state(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.get_state/1.

handle_event(component, event, state)

See Raxol.Protocols.CoreProtocols.Component.handle_event/3.

initialize(component, opts)

See Raxol.Protocols.CoreProtocols.Lifecycle.initialize/2.

merge_config(configurable, config)

See Raxol.Protocols.CoreProtocols.Configurable.merge_config/2.

read(buffer, position)

See Raxol.Protocols.CoreProtocols.BufferOperations.read/2.

render(component, opts)

See Raxol.Protocols.CoreProtocols.Component.render/2.

resize(buffer, width, height)

See Raxol.Protocols.CoreProtocols.BufferOperations.resize/3.

restart(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.restart/1.

scroll(buffer, direction, amount)

See Raxol.Protocols.CoreProtocols.BufferOperations.scroll/3.

serialize(data, format)

See Raxol.Protocols.CoreProtocols.Serializable.serialize/2.

set_config(configurable, config)

See Raxol.Protocols.CoreProtocols.Configurable.set_config/2.

start(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.start/1.

stop(component)

See Raxol.Protocols.CoreProtocols.Lifecycle.stop/1.

validate(component)

See Raxol.Protocols.CoreProtocols.Component.validate/1.

validate_config(configurable, config)

See Raxol.Protocols.CoreProtocols.Configurable.validate_config/2.

write(buffer, position, data)

See Raxol.Protocols.CoreProtocols.BufferOperations.write/3.