pages.shell_actions

Page actions AI-ready formats and sharing
Open LLM text
Share with AI
Ask Claude Ask ChatGPT Ask Gemini Ask Copilot

Route-scoped shell action models and merge helpers.

Nested filesystem routes can contribute actions for persistent shell regions such as the global top bar. Child routes inherit parent contributions by default, may override…

Route-scoped shell action models and merge helpers.

Nested filesystem routes can contribute actions for persistent shell regions such as the global top bar. Child routes inherit parent contributions by default, may override actions by stableid, remove inherited actions, or replace an entire zone.

Stable DOM id for the actions slot: importSHELL_ACTIONS_TARGETfrom chirp.shell_actions or chirp.shell_regions(same constant). See the UI layers guide insite/content/docs/guides/ui-layers.md.

pages.shell_actions

Name Type Default Description
type
qualified_name
element_type
description
source_file
line_number
is_autodoc
autodoc_element
_autodoc_template
_autodoc_url_path
_autodoc_page_type
title
doc_content_hash

Symbols on this page

ShellMenuItem
class

A menu item rendered inside a shell action dropdown.

ShellAction
class

A single action contribution for a shell region.

ShellActionZone
class

A zone contribution with explicit merge semantics.

ShellActions
class

Resolved shell actions for persistent chrome regions.

merge_shell_actions
function
def merge_shell_actions(parent: ShellActions | None, child: ShellActions | None) -> ShellActions | None

Merge route-scoped shell actions from parent to child.

Parameters

Name Type Default Description
parent ShellActions | None
child ShellActions | None
normalize_shell_actions
function
def normalize_shell_actions(value: Any) -> ShellActions | None

Normalize a context value intoShellActions.

Parameters

Name Type Default Description
value Any
shell_actions_fragment
function
def shell_actions_fragment(actions: ShellActions | None, renderer: ShellActionsRenderer | None = None) -> tuple[str, str, str] | None

Return the template, block, and target for shell OOB rendering.

rendererselects the HTML template; the OOB target and wrap contract remain unchanged so applications can swap visuals without rewiring transport.

Parameters

Name Type Default Description
actions ShellActions | None
renderer ShellActionsRenderer | None None
validate_shell_actions
function
def validate_shell_actions(actions: ShellActions) -> None

Validate zone contents and stable action ids.

Parameters

Name Type Default Description
actions ShellActions

View source · /home/runner/work/chirp/chirp/site/../src/chirp/pages/shell_actions.py:1