Socket-first multi-item arrangement and stacking commands.
Arrangement commands operate on the current actor selection unless callers pass
an explicit scope in opts.
Summary
Functions
Aligns items and returns the command result.
Aligns items in the requested scope.
Demotes the requested scope one z-order step and returns the command result.
Demotes the requested scope one z-order step.
Moves the requested scope to the back and returns the command result.
Moves the requested scope to the back.
Distributes items and returns the command result.
Distributes items in the requested scope.
Lays out tileable world items and returns the command result.
Lays out tileable world items using the current actor viewport.
Promotes the requested scope one z-order step and returns the command result.
Promotes the requested scope one z-order step.
Moves the requested scope to the front and returns the command result.
Moves the requested scope to the front.
Marks a viewport item as reserved space and returns the command result.
Marks a viewport item as reserved space for server-side layout planning.
Types
@type align_mode() :: :left | :center | :right | :top | :middle | :bottom
@type command_opts() :: keyword()
@type command_result() :: LivePanels.Canvas.Command.result()
@type distribute_axis() :: :horizontal | :vertical
@type socket() :: Phoenix.LiveView.Socket.t()
@type target() :: LivePanels.Canvas.command_target()
@type z_order_mode() :: :front | :back | :forward | :backward
Functions
@spec align(target(), align_mode() | String.t(), command_opts()) :: command_result()
Aligns items and returns the command result.
@spec align!(target(), align_mode() | String.t(), command_opts()) :: target()
Aligns items in the requested scope.
@spec demote(target(), command_opts()) :: command_result()
Demotes the requested scope one z-order step and returns the command result.
@spec demote!(target(), command_opts()) :: target()
Demotes the requested scope one z-order step.
@spec demote_to_back(target(), command_opts()) :: command_result()
Moves the requested scope to the back and returns the command result.
@spec demote_to_back!(target(), command_opts()) :: target()
Moves the requested scope to the back.
@spec distribute(target(), distribute_axis() | String.t(), command_opts()) :: command_result()
Distributes items and returns the command result.
@spec distribute!(target(), distribute_axis() | String.t(), command_opts()) :: target()
Distributes items in the requested scope.
@spec layout(target(), layout_strategy(), command_opts()) :: command_result()
Lays out tileable world items and returns the command result.
@spec layout!(target(), layout_strategy(), command_opts()) :: target()
Lays out tileable world items using the current actor viewport.
@spec promote(target(), command_opts()) :: command_result()
Promotes the requested scope one z-order step and returns the command result.
@spec promote!(target(), command_opts()) :: target()
Promotes the requested scope one z-order step.
@spec promote_to_front(target(), command_opts()) :: command_result()
Moves the requested scope to the front and returns the command result.
@spec promote_to_front!(target(), command_opts()) :: target()
Moves the requested scope to the front.
@spec reserve_area(target(), LivePanels.Canvas.Item.item_ref(), command_opts()) :: command_result()
Marks a viewport item as reserved space and returns the command result.
@spec reserve_area!(target(), LivePanels.Canvas.Item.item_ref(), command_opts()) :: target()
Marks a viewport item as reserved space for server-side layout planning.