Skip to content

Enums reference

Lattice uses backed enums for the fixed vocabularies that appear in builders — alignments, gaps, variants, operators, and so on. Each is generated to a TypeScript union too, so the PHP value and the client type can’t drift. The string value in parentheses is what ends up on the wire.

The case lists below are generated by reflecting over the real enums (tests/Unit/Docs/EnumDocsTest.php dumps them to docs/fixtures/enums.json), so this page can never fall behind the code.

Lattice\Lattice\Core\Enums — the vocabulary for arranging components, used by Stack and the other layout primitives.

Enum Cases (value)
Align Center (center) , Left (left) , Start (start) , Stretch (stretch)
Justify Start (start) , Center (center) , End (end) , Between (between) , Around (around) , Evenly (evenly)
Gap None (none) , ExtraSmall (xs) , Small (sm) , Medium (md) , Large (lg) , ExtraLarge (xl)
Width Full (full) , Auto (auto) , Small (sm) , Medium (md) , Large (lg) , Fill (fill)
Height Full (full) , Screen (screen)
Orientation Horizontal (horizontal) , Vertical (vertical)
Placement Top (top) , Bottom (bottom) , Right (right)
FloatingPlacement BottomEnd (bottom-end) , BottomStart (bottom-start) , TopEnd (top-end) , TopStart (top-start)
Side Start (start) , End (end)
TabsAlignment Start (start) , Center (center) , End (end) , Stretch (stretch)
RowLayout Stack (stack) , Table (table)

Lattice\Lattice\Core\Enums — how a page frames itself and which layout it renders into.

Enum Cases (value)
PageLayout App (app) , Auth (auth) , None (none)
PageContainer Centered (centered) , Default (default)

Lattice\Lattice\Core\Enums — sizing and color for Text, Icon, table columns, and form-field width.

Enum Cases (value)
Size Xs (xs) , Sm (sm) , Md (md) , Lg (lg) , Xl (xl) , Xl2 (2xl) , Xl3 (3xl) , Xl4 (4xl)
Color Default (default) , Muted (muted) , Primary (primary) , Success (success) , Info (info) , Warning (warning) , Danger (danger)
ColumnWidth Xs (xs) , Sm (sm) , Md (md) , Lg (lg) , Xl (xl)

The icon names a Lattice\Lattice\Core\Enums\Icon accepts are listed on the Icons page.

Lattice\Lattice\Core\Enums

Enum Cases (value)
ButtonVariant Default (default) , Destructive (destructive) , Ghost (ghost) , Info (info) , Link (link) , Outline (outline) , Secondary (secondary) , Success (success)
ButtonType Button (button) , Submit (submit) , Reset (reset)
HttpMethod Get (get) , Post (post) , Put (put) , Patch (patch) , Delete (delete)
Variant Success (success) , Info (info) , Warning (warning) , Error (error)

Variant is used by toasts and callouts.

Lattice\Lattice\Core\Enums\Op — the shared comparison vocabulary used by both form conditions and table filters.

Enum Cases (value)
Op Contains (contains) , StartsWith (starts_with) , EndsWith (ends_with) , Equals (eq) , NotEquals (neq) , GreaterThan (gt) , GreaterThanOrEqual (gte) , LessThan (lt) , LessThanOrEqual (lte) , In (in) , NotIn (not_in) , Before (before) , After (after) , Empty (empty) , Filled (filled)

Lattice\Lattice\Tables\Enums — column types, alignment, number formatting, filtering, and pagination for tables.

Enum Cases (value)
ColumnType Text (column.text) , Boolean (column.boolean) , Number (column.number) , Money (column.money) , Stack (column.stack) , Badge (column.badge) , Icon (column.icon) , Image (column.image)
ColumnAlign Start (start) , Center (center) , End (end)
DateTimeStyle Full (full) , Long (long) , Medium (medium) , Short (short)
NumberFormatUnit Percent (percent) , Kilogram (kilogram) , Gram (gram) , Kilometer (kilometer) , Meter (meter) , Byte (byte) , Kilobyte (kilobyte) , Megabyte (megabyte) , Gigabyte (gigabyte) , Millisecond (millisecond) , Second (second) , Minute (minute) , Hour (hour) , Celsius (celsius) , Fahrenheit (fahrenheit)
FilterType Text (text) , Number (number) , Date (date) , Boolean (boolean)
FilterControl Select (select) , Ternary (ternary) , DateRange (date-range) , Toggle (toggle)
PaginationType None (none) , Simple (simple) , Table (table) , Infinite (infinite)
SortDirection Asc (asc) , Desc (desc)

The row layout and built-in row actions used by the repeater and builder fields, plus the field-type vocabulary.

Enum Namespace Cases (value)
FieldType Forms\Enums Builder (field.builder) , Checkbox (field.checkbox) , Choice (field.choice) , DateInput (field.date-input) , DateTimeInput (field.date-time-input) , FileUpload (field.file-upload) , HiddenInput (field.hidden-input) , NumberInput (field.number-input) , Otp (field.otp) , PasswordInput (field.password-input) , Repeater (field.repeater) , RichEditor (field.rich-editor) , Select (field.select) , Textarea (field.textarea) , TextInput (field.text-input) , TimeInput (field.time-input) , Toggle (field.toggle)
RowActionType Forms\Enums Duplicate (duplicate) , Remove (remove)

Lattice\Lattice\Core\Enums — the series shapes a Chart component can render.

Enum Cases (value)
ChartSeriesType Area (area) , Bar (bar) , Line (line) , Pie (pie)

Lattice\Lattice\Chat\Enums — the message roles and part kinds used by the chat components.

Enum Cases (value)
ChatRole User (user) , Assistant (assistant) , System (system)
ChatPartType Text (chat.part.text) , ToolCall (chat.part.tool-call)

Lattice\Lattice\Realtime\Enums — the broadcast channel visibility a page listener subscribes to.

Enum Cases (value)
ChannelVisibility Public (public) , Private (private) , Presence (presence)