Skip to main content

core.statusview

Status bar with customizable items displaying document info and system status. Access the global instance via core.status_view.

local statusview = require "core.statusview"

Item​

(field) Item: core.statusview.item

Individual status bar item with custom rendering and interaction.

__index​

(field) __index: core.object

Base class providing OOP functionality for Lua. All classes in Pragtical inherit from Object.

active_items​

(field) active_items: core.statusview.item[]

Currently visible items that pass predicates

context​

(field) context: 'application'|'session'

current_scale​

(field) current_scale: number

cursor​

(field) cursor: string

dragged_panel​

(field) dragged_panel: ""|"left"|"right"

Panel being dragged ("left", "right", or "")

get_items_warn​

(field) get_items_warn: boolean

h_scrollbar​

(field) h_scrollbar: core.scrollbar

Scrollable viewport indicator with draggable thumb. Supports both vertical and horizontal orientation with configurable alignment. Uses a "normal" coordinate system internally that treats all scrollbars as vertical-end-aligned, then transforms to the actual orientation/alignment.

hide_messages​

(field) hide_messages: boolean

Whether to suppress status messages

hovered_item​

(field) hovered_item: core.statusview.item

Item currently under mouse cursor

hovered_panel​

(field) hovered_panel: ""|"left"|"right"

Panel under cursor ("left", "right", or "")

hovered_scrollbar​

(field) hovered_scrollbar: boolean

items​

(field) items: core.statusview.item[]

All registered items

left_width​

(field) left_width: number

Visible width of left panel

left_xoffset​

(field) left_xoffset: number

Horizontal pan offset for left panel

message​

(field) message: table<integer, string|renderer.color|renderer.font>

Current temporary message content

message_timeout​

(field) message_timeout: number

Timestamp when current message expires

pointer​

(field) pointer: table

r_left_width​

(field) r_left_width: number

Real (total) width of left panel content

r_right_width​

(field) r_right_width: number

Real (total) width of right panel content

right_width​

(field) right_width: number

Visible width of right panel

right_xoffset​

(field) right_xoffset: number

Horizontal pan offset for right panel

scroll​

(field) scroll: core.view.scroll

scrollable​

(field) scrollable: boolean

separator​

(field) separator: string

Space separator

separator2​

(field) separator2: string

Pipe separator

size​

(field) size: core.view.position

super​

(field) super: core.view

Base view.

tooltip​

(field) tooltip: table<integer, string|renderer.color|renderer.font>

Persistent tooltip content

tooltip_mode​

(field) tooltip_mode: boolean

Whether persistent tooltip is active

v_scrollbar​

(field) v_scrollbar: core.scrollbar

Scrollable viewport indicator with draggable thumb. Supports both vertical and horizontal orientation with configurable alignment. Uses a "normal" coordinate system internally that treats all scrollbars as vertical-end-aligned, then transforms to the actual orientation/alignment.

visible​

(field) visible: boolean

core.statusview.item​

Individual status bar item with custom rendering and interaction.

LEFT​

(field) LEFT: integer

Align item on left side of status bar.

(field) RIGHT: integer

Align item on right side of status bar.

__index​

(field) __index: core.object

Base class providing OOP functionality for Lua. All classes in Pragtical inherit from Object.

active​

(field) active: boolean

Whether item passes predicate check

alignment​

(field) alignment: `StatusView.Item.LEFT`|`StatusView.Item.RIGHT`

Left or right side placement

background_color​

(field) background_color: renderer.color|nil

Normal background color

background_color_hover​

(field) background_color_hover: renderer.color|nil

Hover background color

cached_item​

(field) cached_item: table<integer, string|renderer.color|renderer.font>

Cached rendered content

command​

(field) command: string|nil

Command name to execute on click

name​

(field) name: string

Unique identifier for the item

on_click​

(field) on_click: fun(button: string, x: number, y: number)|nil

Click handler function

on_draw​

(field) on_draw: fun(x: any, y: any, h: any, hovered: boolean, calc_only?: boolean):number|nil

Custom drawing function

predicate​

(field) predicate: fun():boolean

Condition to display item

separator​

(field) separator: `StatusView.separator2`|`StatusView.separator`

Separator style

super​

(field) super: core.object

Base class providing OOP functionality for Lua. All classes in Pragtical inherit from Object.

tooltip​

(field) tooltip: string

Text shown on mouse hover

visible​

(field) visible: boolean

Whether item is shown

w​

(field) w: number

Width in pixels (calculated)

x​

(field) x: number

Horizontal position (calculated)

get_item​

fun(self: core.statusview.item):table<integer, string|renderer.color|renderer.font>?, table<integer, string|renderer.color|renderer.font>?

__call​

(method) core.object:__call(...any)
  -> obj: core.object

Metamethod allowing class to be called like a constructor. Enables syntax: local obj = MyClass(args) instead of MyClass:new(args) Automatically creates instance and calls new() with provided arguments.

@return obj — The new instance of the class

__tostring​

(method) core.statusview.item:__tostring()
  -> string

extend​

(method) core.object:extend()
  -> cls: core.object

Create a new class that inherits from this one. Returns a new class with this class as its parent. Example: local MyClass = Object:extend()

@return cls — The new class table

extends​

(method) core.object:extends(T: any)
  -> extends: boolean

Check if object inherits from the given type (inheritance-aware). Use this to check class hierarchy. Example: view:extends(View) returns true for View and all subclasses

@param T — Class to check inheritance from

@return extends — True if object is T or inherits from T

get_item​

(method) core.statusview.item:get_item()
  -> table<integer, string|renderer.color|renderer.font>

Generate the styled text for this item. Override this method or pass get_item in options. Ignored if on_draw is set.

hide​

(method) core.statusview.item:hide()

Hide the item from the status bar.

is​

(method) core.object:is(T: any)
  -> is_exact: boolean

Check if object is exactly of the given type (no inheritance check). Use this for strict type matching. Example: view:is(DocView) returns true only if view is a DocView, not a subclass

@param T — Class to check against

@return is_exact — True if object is exactly type T

is_class_of​

(method) core.object:is_class_of(T: any)
  -> is_instance: boolean

Check if the given object is exactly an instance of this class. Inverse of is() - checks if T is an instance of self. Example: DocView:is_class_of(obj) checks if obj is exactly a DocView

@param T — Object to check

@return is_instance — True if T is exactly an instance of this class

is_extended_by​

(method) core.object:is_extended_by(T: any)
  -> is_extended: boolean

Check if the given object/class inherits from this class. Inverse of extends() - checks if T is a subclass of self. Example: View:is_extended_by(DocView) checks if DocView inherits from View

@param T — Object or class to check

@return is_extended — True if T inherits from this class

new​

(method) core.statusview.item:new(options: core.statusview.item.options)

Create a new status bar item.

set_predicate​

(method) core.statusview.item:set_predicate(predicate: string|table|fun():boolean)

Set the condition to evaluate whether this item should be displayed. String: treated as module name (e.g. "core.docview"), checked against active view. Table: treated as class, checked against active view with is(). Function: called each update, should return boolean. Nil: always displays the item.

show​

(method) core.statusview.item:show()

Show the item on the status bar.

core.statusview.item.alignment​

core.statusview.item.alignment:
   -\> `StatusView.Item.LEFT`
    | `StatusView.Item.RIGHT`

core.statusview.item.get_item​

core.statusview.item.onclick​

core.statusview.item.ondraw​

core.statusview.item.options​

Options for creating a status bar item.

alignment​

(field) alignment: `StatusView.Item.LEFT`|`StatusView.Item.RIGHT`

Left or right side placement

command​

(field) command: string|fun(button: string, x: number, y: number)|nil

Command name or click callback

get_item​

(field) get_item: fun(self: core.statusview.item):table<integer, string|renderer.color|renderer.font>?, table<integer, string|renderer.color|renderer.font>?

Function returning styled text (can return empty table)

name​

(field) name: string

Unique identifier for the item

position​

(field) position: integer?

Insertion position (-1=end, 1=beginning)

predicate​

(field) predicate: string|table|fun():boolean

Condition for display (string=module, table=class, function=custom, nil=always)

separator​

(field) separator: (`StatusView.separator2`|`StatusView.separator`)?

Separator style (space or pipe)

tooltip​

(field) tooltip: string?

Text displayed on mouse hover

visible​

(field) visible: boolean?

Initial visibility state

core.statusview.item.predicate​

core.statusview.item.separator​

core.statusview.item.separator:
   -\> `StatusView.separator`
    | `StatusView.separator2`

core.statusview.position​

Left or right alignment identifier.

core.statusview.styledtext​

Styled text array containing fonts, colors, and strings.

from_state​

function core.view.from_state(state: table)
  -> view: (core.view)?

Create and initialize a new view instance from a previously saved state.

This function is called when restoring workspace/session state. Implementations are responsible for:

  • creating the view instance
  • applying any persisted state

If loading the instance failed nil will be returned.

__call​

(method) core.object:__call(...any)
  -> obj: core.object

Metamethod allowing class to be called like a constructor. Enables syntax: local obj = MyClass(args) instead of MyClass:new(args) Automatically creates instance and calls new() with provided arguments.

@return obj — The new instance of the class

__tostring​

(method) core.statusview:__tostring()
  -> string

add_item​

(method) core.statusview:add_item(options: core.statusview.item.options)
  -> item: core.statusview.item

Add a new item to the status bar.

@return item — The created item

clamp_scroll_position​

(method) core.view:clamp_scroll_position()

Clamp scroll position to valid range (0 to max scrollable size). Called automatically by update(). Override get_scrollable_size() to customize.

display_messages​

(method) core.statusview:display_messages(enable: boolean)

Enable or disable system messages on the status bar.

@param enable — True to show messages, false to hide them

drag_panel​

(method) core.statusview:drag_panel(panel: "left"|"right", dx: number)

Pan a status bar panel horizontally when content overflows.

@param panel — Panel to drag ("left" or "right")

@param dx — Horizontal drag distance in pixels

-- Left or right alignment identifier.
panel:
    | "left"
    | "right"

draw​

(method) core.statusview:draw()

Render the status bar with all active items, messages, and tooltips.

draw_background​

(method) core.view:draw_background(color: renderer.color)

Draw a solid background color for the entire view. Commonly called at the start of draw() methods.

draw_item_tooltip​

(method) core.statusview:draw_item_tooltip(item: core.statusview.item)

Draw a tooltip box above the status bar for an item.

@param item — Item with tooltip text

draw_items​

(method) core.statusview:draw_items(items: table<integer, string|renderer.color|renderer.font>, right_align?: boolean, xoffset?: number, yoffset?: number)

Draw styled text on the status bar with optional alignment.

@param items — Styled text to render

@param right_align — True to right-align, false for left-align

@param xoffset — Horizontal offset in pixels

@param yoffset — Vertical offset in pixels

draw_scrollbar​

(method) core.view:draw_scrollbar()

Draw the view's scrollbars. Commonly called at the end of draw() methods.

extend​

(method) core.object:extend()
  -> cls: core.object

Create a new class that inherits from this one. Returns a new class with this class as its parent. Example: local MyClass = Object:extend()

@return cls — The new class table

extends​

(method) core.object:extends(T: any)
  -> extends: boolean

Check if object inherits from the given type (inheritance-aware). Use this to check class hierarchy. Example: view:extends(View) returns true for View and all subclasses

@param T — Class to check inheritance from

@return extends — True if object is T or inherits from T

get_content_bounds​

(method) core.view:get_content_bounds()
  -> x1: number
  2. y1: number
  3. x2: number
  4. y2: number

Get the content bounds in content coordinates (accounting for scroll).

@return x1 — Left edge

@return y1 — Top edge

@return x2 — Right edge

@return y2 — Bottom edge

get_content_offset​

(method) core.view:get_content_offset()
  -> x: number
  2. y: number

Get the top-left corner of content area in screen coordinates. Accounts for scroll offset. Use for drawing content at correct position.

@return x — Screen x coordinate

@return y — Screen y coordinate

get_h_scrollable_size​

(method) core.view:get_h_scrollable_size()
  -> width: number

Get the total scrollable width of the view's content. Used by horizontal scrollbar.

@return width — Width in pixels (default: 0, no horizontal scroll)

get_hovered_panel​

(method) core.statusview:get_hovered_panel(x: number, y: number)
  -> panel: string

Determine which panel (left or right) is under the cursor.

@param x — Mouse x coordinate

@param y — Mouse y coordinate

@return panel — "left", "right", or "" if none

get_item​

(method) core.statusview:get_item(name: string)
  -> item: core.statusview.item|nil

Get a status bar item by name.

@param name — Unique item name

@return item — The item or nil if not found

get_item_visible_area​

(method) core.statusview:get_item_visible_area(item: core.statusview.item)
  -> x: number
  2. w: number

Calculate the visible portion of an item considering panel overflow.

@param item — Item to check

@return x — Visible x coordinate (0 if fully clipped)

@return w — Visible width (0 if fully clipped)

get_items​

(method) core.statusview:get_items(nowarn: boolean)
  -> left: table
  2. right: table

Legacy method for retrieving status bar items.

@param nowarn — Suppress deprecation warning if true

@return left — Left-aligned items

@return right — Right-aligned items

get_items_list​

(method) core.statusview:get_items_list(alignment?: `StatusView.Item.LEFT`|`StatusView.Item.RIGHT`)
  -> items: core.statusview.item[]

Get all items or items filtered by alignment.

@param alignment — Filter by left or right alignment

@return items — List of items

alignment:
   -\> `StatusView.Item.LEFT`
    | `StatusView.Item.RIGHT`

get_module​

(method) core.view:get_module()
  -> path: string?

Returns the module path of this view.

This method resolves the Lua module name that loaded the concrete view class (for example "core.view").

If the view class cannot be associated with any loaded module, nil is returned.

get_name​

(method) core.view:get_name()
  -> name: string

Get the name displayed in the view's tab. Override to show document name, file path, etc.

get_scrollable_size​

(method) core.view:get_scrollable_size()
  -> height: number

Get the total scrollable height of the view's content. Used by scrollbar to calculate thumb size and position.

@return height — Height in pixels (default: infinite)

get_state​

(method) core.view:get_state()
  -> state: table?

Serialize this view into a persistable state table.

This method is called when the editor is saving workspace/session state. The returned table must contain only plain Lua data (no functions, userdata, metatables, or cyclic references).

Returning nil indicates that this view should NOT be restored when reloading the workspace.

hide​

(method) core.statusview:hide()

Hide the status bar.

hide_items​

(method) core.statusview:hide_items(names?: string|table<integer, string>)

Hide specific items or all items if no names provided.

@param names — Single name or list of item names

is​

(method) core.object:is(T: any)
  -> is_exact: boolean

Check if object is exactly of the given type (no inheritance check). Use this for strict type matching. Example: view:is(DocView) returns true only if view is a DocView, not a subclass

@param T — Class to check against

@return is_exact — True if object is exactly type T

is_class_of​

(method) core.object:is_class_of(T: any)
  -> is_instance: boolean

Check if the given object is exactly an instance of this class. Inverse of is() - checks if T is an instance of self. Example: DocView:is_class_of(obj) checks if obj is exactly a DocView

@param T — Object to check

@return is_instance — True if T is exactly an instance of this class

is_extended_by​

(method) core.object:is_extended_by(T: any)
  -> is_extended: boolean

Check if the given object/class inherits from this class. Inverse of extends() - checks if T is a subclass of self. Example: View:is_extended_by(DocView) checks if DocView inherits from View

@param T — Object or class to check

@return is_extended — True if T inherits from this class

move_item​

(method) core.statusview:move_item(name: string, position: integer, alignment?: `StatusView.Item.LEFT`|`StatusView.Item.RIGHT`)
  -> moved: boolean

Move an item to a different position.

@param name — Item name to move

@param position — New position (negative for reverse order)

@param alignment — Optional new alignment

@return moved — True if item was found and moved

alignment:
   -\> `StatusView.Item.LEFT`
    | `StatusView.Item.RIGHT`

move_towards​

(method) core.view:move_towards(t: table, k: string|number, dest: number, rate?: number, name?: string)

Smoothly animate a value towards a destination. Use this for animations instead of direct assignment.

@param t — Table containing the value

@param k — Key in table

@param dest — Target value

@param rate — Animation speed (0-1, default 0.5, higher = faster)

@param name — Transition name (for config.disabled_transitions)

new​

(method) core.statusview:new()

Create a new status bar and register default items.

on_file_dropped​

(method) core.view:on_file_dropped(filename: string, x: number, y: number)
  -> consumed: boolean

Handle file drop events (drag and drop from OS). Override to handle dropped files. Return true to consume event.

@param filename — Absolute path to dropped file

@param x — Screen x where file was dropped

@param y — Screen y where file was dropped

@return consumed — True to consume event, false to propagate

on_ime_text_editing​

(method) core.view:on_ime_text_editing(text: string, start: number, length: number)

Handle IME (Input Method Editor) text composition events. Override for IME support in text editors. Called during composition.

@param text — Composition text being edited

@param start — Start position of selection within composition

@param length — Length of selection within composition

on_mouse_left​

(method) core.statusview:on_mouse_left()

Handle mouse leaving the status bar area.

on_mouse_moved​

(method) core.statusview:on_mouse_moved(x: number, y: number, dx: number, dy: number)

Handle mouse movement over the status bar. Updates hovered item, cursor, and handles panel dragging.

@param x — Mouse x coordinate

@param y — Mouse y coordinate

@param dx — Delta x movement

@param dy — Delta y movement

on_mouse_pressed​

(method) core.statusview:on_mouse_pressed(button: string, x: number, y: number, clicks: number)
  -> boolean

Handle mouse button press events. Clicking on active message opens log view. Left-click enables panel dragging when content overflows.

@param button — Mouse button identifier

@param x — Mouse x coordinate

@param y — Mouse y coordinate

@param clicks — Number of clicks

on_mouse_released​

(method) core.statusview:on_mouse_released(button: string, x: number, y: number)

Handle mouse button release events. Executes item command or callback if clicked on an item.

@param button — Mouse button identifier

@param x — Mouse x coordinate

@param y — Mouse y coordinate

on_mouse_wheel​

(method) core.statusview:on_mouse_wheel(y: number, x: number)

Handle mouse wheel scrolling to pan overflowing panels.

@param y — Vertical scroll amount

@param x — Horizontal scroll amount

on_scale_change​

(method) core.view:on_scale_change(new_scale: number, prev_scale: number)

Called when DPI scale changes (display moved, zoom changed, etc.). Override to adjust sizes, padding, or other scale-dependent values.

@param new_scale — New scale factor (e.g., 1.0, 1.5, 2.0)

@param prev_scale — Previous scale factor

on_text_input​

(method) core.view:on_text_input(text: string)

Handle text input events (typing, IME composition). Override for text editing. Called after IME composition completes.

@param text — Input text (may be multiple characters)

on_touch_moved​

(method) core.view:on_touch_moved(x: number, y: number, dx: number, dy: number, i: number)

Handle touch move events (touchscreen/trackpad gestures). Override for touch-specific behavior. Base implementation handles scrolling.

@param x — Current touch x coordinate

@param y — Current touch y coordinate

@param dx — Delta x since last position

@param dy — Delta y since last position

@param i — Touch finger/pointer index

order_items​

(method) core.statusview:order_items(names: table<integer, string>)

Reorder items by the given name list. Items are placed at the beginning in the order specified.

@param names — List of item names in desired order

register_command_items​

(method) core.statusview:register_command_items()

Register default status bar items for command views. Shows file count icon.

register_docview_items​

(method) core.statusview:register_docview_items()

Register default status bar items for document views. Shows file, position, selections, indentation, encoding, line ending, etc.

register_imageview_items​

(method) core.statusview:register_imageview_items()

Register default status bar items for image views. Shows image filename, dimensions, and zoom level.

remove_item​

(method) core.statusview:remove_item(name: string)
  -> removed_item: core.statusview.item|nil

Remove an item from the status bar.

@param name — Item name to remove

@return removed_item — The removed item or nil

remove_tooltip​

(method) core.statusview:remove_tooltip()

Hide the persistent tooltip and restore normal status bar items.

scrollbar_dragging​

(method) core.view:scrollbar_dragging()
  -> dragging: boolean

Check if user is currently dragging either scrollbar.

@return dragging — True if scrollbar drag is in progress

scrollbar_hovering​

(method) core.view:scrollbar_hovering()
  -> hovering: boolean

Check if mouse is hovering over either scrollbar track.

@return hovering — True if mouse is over scrollbar

scrollbar_overlaps_point​

(method) core.view:scrollbar_overlaps_point(x: number, y: number)
  -> overlaps: boolean

Check if a screen point overlaps either scrollbar. Useful for determining cursor style or handling clicks.

@param x — Screen x coordinate

@param y — Screen y coordinate

@return overlaps — True if point is over vertical or horizontal scrollbar

show​

(method) core.statusview:show()

Show the status bar.

show_items​

(method) core.statusview:show_items(names?: string|table<integer, string>)

Show specific items or all items if no names provided.

@param names — Single name or list of item names

show_message​

(method) core.statusview:show_message(icon: string, icon_color: renderer.color, text: string)

Display a temporary message in the status bar. Message duration is controlled by config.message_timeout.

@param icon — Icon character to display

@param icon_color — Icon color

@param text — Message text

show_tooltip​

(method) core.statusview:show_tooltip(text: string|table<integer, string|renderer.color|renderer.font>)

Show a persistent tooltip replacing all status bar content. Remains visible until remove_tooltip() is called.

@param text — Plain text or styled text array

supports_text_input​

(method) core.view:supports_text_input()
  -> boolean

Whether this view accepts text input (enables IME). Override and return true for text editors and input fields.

toggle​

(method) core.statusview:toggle()

Toggle status bar visibility.

try_close​

(method) core.view:try_close(do_close: function)

Called when view is requested to close (e.g., tab close button). Override to show confirmation dialogs for unsaved changes. Example: core.command_view:enter("Save?", \{submit = do_close\})

@param do_close — Call this function to actually close the view

update​

(method) core.statusview:update()

Update status bar height, message scroll, and active items.

update_active_items​

(method) core.statusview:update_active_items()

Rebuild the active items list by evaluating predicates and calculating positions. Updates item visibility, positions, and handles panel overflow.

update_scrollbar​

(method) core.view:update_scrollbar()

Update scrollbar positions and sizes. Called automatically by update(). Rarely needs to be called manually.