15 - Control catalogue
Every control Type the Canvas engine can build, which -Properties keys it actually reads, and the cmdlet that emits it. Generated from Launcher\Designer\catalog.json - do not edit by hand; run Launcher\Designer\Tools\Extract-CanvasCatalog.ps1 then Build-CanvasCatalog.ps1.
Why this exists: a key the factory does not read is accepted and ignored, not rejected. ImageWidth on an Image rendered the icon at full bleed; -Padding on a stack rendered a blank page. This table is the ground truth the engine-side [unused property] warning checks against.
Keys every control honours
| Group | Keys |
|---|---|
| Style | Background FontFamily FontSize FontWeight Foreground HAlign HorizontalAlignment Margin Opacity VAlign VerticalAlignment |
| Glow | Fill Foreground Glow GlowPulse GlowRadius |
| Geometry (top-level fields, not Properties) | X Y Width Height ZIndex |
| Container-only | Background BackgroundImage BackgroundOpacity BackgroundStretch Columns ColumnWidths CornerRadius HoverBackground Layout Padding Scroll SelectedIndex Stagger Stretch StretchDirection |
| Read off a CHILD by its parent (Grid/Dock) | Column ColumnSpan Dock Row RowSpan |
Layouts (case-insensitive; anything else falls back to absolute Canvas): dock, grid, horizontal, hstack, stack, vertical, vstack, wrap. Dock is valid on Add-UICanvasPage only - Add-UICanvasPanel -Layout Dock fails its ValidateSet.
Container
GridSplitter
Draggable divider; must occupy its own Grid cell between two panes.
Cmdlet: Add-UICanvasGridSplitter
Add-UICanvasGridSplitter -Orientation Vertical| Property | Type | Values |
|---|---|---|
Background | String | |
Orientation | String | Vertical | Horizontal |
Thickness | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Panel
Generic container. -Layout picks Canvas (absolute X/Y) or a flow layout. NOTE: Dock is a PAGE layout and is rejected here; -Padding on a stack layout has rendered pages blank - inset with child Margins instead.
Cmdlet: Add-UICanvasPanel - container
Add-UICanvasPanel -Layout VStack -Spacing 8 -Children { Add-UICanvasLabel 'Inside' }| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | Int32 | |
ColumnWidths | String | |
CornerRadius | Double | |
HoverBackground | String | |
HoverScale | String | |
HoverScaleMs | String | |
Layout | String | Canvas | Stack | VStack | HStack | Grid | Wrap |
Padding | Double | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String | |
Spacing * | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Card
Panel with card chrome (background, radius, shadow). -Action makes the whole card clickable.
Cmdlet: Add-UICanvasCard - container
Add-UICanvasCard -Layout VStack -Spacing 8 -Children { Add-UICanvasLabel 'Card' }| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | Int32 | |
ColumnWidths | String | |
CornerRadius | Double | |
HoverBackground | String | |
HoverScale | String | |
HoverScaleMs | String | |
Layout | String | Canvas | Stack | VStack | HStack | Grid | Wrap |
Padding | Double | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String | |
Spacing * | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Group
Engine spelling of a plain Panel. No cmdlet emits it; Add-UICanvasControl -Type Group reaches it.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
HoverScale | String | |
HoverScaleMs | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
ControlGroup
Engine spelling of a Card (gets card chrome). No cmdlet emits it; prefer Add-UICanvasCard.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
HoverScale | String | |
HoverScaleMs | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Expander
Collapsible section.
Cmdlet: Add-UICanvasExpander - container
Add-UICanvasExpander -Label 'More' -IsExpanded $false -Children { Add-UICanvasLabel 'Hidden' }| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | Double | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String | |
IsExpanded * | Boolean |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
CardExpander
Engine type 'CardExpander'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Stack
Engine type 'Stack'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
VStack
Engine type 'VStack'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
HStack
Engine type 'HStack'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Grid
Engine type 'Grid'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Wrap
Engine type 'Wrap'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Dock
Engine type 'Dock'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Tabs
Tab strip; children must be Add-UICanvasTab. Value is the selected index.
Cmdlet: Add-UICanvasTabs - container
Add-UICanvasTabs -Name tabs1 -Children { Add-UICanvasTab 'One' -Children { Add-UICanvasLabel 'A' }; Add-UICanvasTab 'Two' -Children { Add-UICanvasLabel 'B' } }| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | Int32 | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
TabControl
Engine type 'TabControl'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Tab
One page of a Tabs control. Only valid inside Add-UICanvasTabs.
Cmdlet: Add-UICanvasTab - container
Add-UICanvasTab 'Tab' -Children { Add-UICanvasLabel 'content' }| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | Int32 | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | VStack | HStack | Grid | Wrap | Canvas |
Padding | Object | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String | |
Spacing * | Double | |
Disabled * | SwitchParameter |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
TabItem
Engine type 'TabItem'. No authoring cmdlet emits it directly.
| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | |
StretchDirection | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Viewbox
Scales its single child to fit.
Cmdlet: Add-UICanvasViewbox - container
Add-UICanvasViewbox -Stretch Uniform -Children { Add-UICanvasLabel 'Scaled' -FontSize 40 }| Property | Type | Values |
|---|---|---|
Background | String | |
BackgroundImage | String | |
BackgroundOpacity | String | |
BackgroundStretch | String | |
Columns | String | |
ColumnWidths | String | |
CornerRadius | String | |
HoverBackground | String | |
Layout | String | VStack | HStack | Grid | Wrap | Canvas |
Padding | String | |
Scroll | String | |
SelectedIndex | String | |
Stagger | String | |
Stretch | String | Uniform | Fill | UniformToFill | None |
StretchDirection | String | Both | UpOnly | DownOnly |
Spacing * | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Display
Label (also TextBlock)
Static or refreshing text. -Label { } with -Refresh re-evaluates on a timer; Selectable renders a read-only TextBox so log text can be copied.
Cmdlet: Add-UICanvasLabel
Add-UICanvasLabel 'Label' -Name lbl1| Property | Type | Values |
|---|---|---|
FontSize | Double | |
FontWeight | String | |
Foreground | String | |
Selectable | String | |
Bind * | String | |
Clock * | String | |
ClockStop * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Icon (also FontIcon)
A glyph by name or MDL2 code point, or a PNG path.
Cmdlet: Add-UICanvasIcon
Add-UICanvasIcon 'info' -FontSize 20| Property | Type | Values |
|---|---|---|
FontSize | Double | |
Foreground | String | |
Height | Double | |
Icon | String | |
Width | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Badge (also Pill, Tag)
Small status pill.
Cmdlet: Add-UICanvasBadge
Add-UICanvasBadge 'Ready' -Severity Success| Property | Type | Values |
|---|---|---|
Background | String | |
FontSize | Double | |
Foreground | String | |
Icon | String | |
Severity | String | Neutral | Info | Success | Warning | Error |
Style | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Markdown
Rendered markdown from -Text or -Path.
Cmdlet: Add-UICanvasMarkdown
Add-UICanvasMarkdown -Text '# Title'| Property | Type | Values |
|---|---|---|
Path | String | |
Text | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Image
Raster image from a path. Size it with -Width/-Height: the ImageWidth property is read only by Banner and is ignored here.
Cmdlet: Add-UICanvasImage
Add-UICanvasImage -Source 'C:\path\logo.png' -Width 64 -Height 64| Property | Type | Values |
|---|---|---|
Stretch | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Hyperlink
Opens http/https/mailto/file URIs only.
Cmdlet: Add-UICanvasHyperlink
Add-UICanvasHyperlink 'Docs' -NavigateUri 'https://example.com'| Property | Type | Values |
|---|---|---|
Foreground | String | |
Glow | String | |
GlowRadius | String | |
HoverForeground | String | |
HoverGlow | String | |
NavigateUri | String | |
Underline | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Separator
Horizontal rule.
Cmdlet: Add-UICanvasSeparator
Add-UICanvasSeparatorReads no type-specific properties; the universal keys above still apply.
Banner (also InfoBar)
Prominent header strip with optional icon and hero image.
Cmdlet: Add-UICanvasBanner
Add-UICanvasBanner 'Heading' -Severity Informational| Property | Type | Values |
|---|---|---|
Icon | String | |
IconSize | String | |
Image | String | |
ImageWidth | String | |
Severity | String | Informational | Success | Warning | Error |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Input
TextBox
Single-line input. Value comes back in the result under -Name.
Cmdlet: Add-UICanvasTextBox
Add-UICanvasTextBox -Name text1 -Placeholder 'Type here'| Property | Type | Values |
|---|---|---|
Placeholder | String | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
MultiLine
Multi-line text input.
Cmdlet: Add-UICanvasMultiLine
Add-UICanvasMultiLine -Name notes1 -Placeholder 'Notes'| Property | Type | Values |
|---|---|---|
Placeholder | String | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
RichEdit
Emitted by Add-UICanvasRichEdit.
Cmdlet: Add-UICanvasRichEdit
Add-UICanvasRichEdit -Name richedit1| Property | Type | Values |
|---|---|---|
Placeholder | String | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Password
Masked input. Returned as SecureString; DPAPI-protected in the result file. No -Value, no -OnChange by design.
Cmdlet: Add-UICanvasPassword
Add-UICanvasPassword -Name pwd1 -Placeholder 'Password'| Property | Type | Values |
|---|---|---|
Placeholder * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Numeric
Numeric spinner. Emitted by Add-UICanvasNumber; Minimum/Maximum/Step live in Properties.
Cmdlet: Add-UICanvasNumber
Add-UICanvasNumber -Name num1 -Value 1 -Minimum 0 -Maximum 100| Property | Type | Values |
|---|---|---|
Maximum | Double | |
Minimum | Double | |
Step | String | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
NumberBox
Emitted by Add-UICanvasNumberBox.
Cmdlet: Add-UICanvasNumberBox
Add-UICanvasNumberBox -Name numberbox1| Property | Type | Values |
|---|---|---|
Maximum | Double | |
Minimum | Double | |
Step | Double | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Dropdown (also ComboBox)
Single-select list. -DependsOn + -OptionsScript make it cascade from other fields.
Cmdlet: Add-UICanvasDropdown
Add-UICanvasDropdown -Name pick1 -Choices @('One','Two','Three') -Value 'One'| Property | Type | Values |
|---|---|---|
ItemIcons | String[] | |
Bind * | String | |
DependsOn * | String[] | |
OptionsScript * | ScriptBlock |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
ListBox
Visible list of choices.
Cmdlet: Add-UICanvasListBox
Add-UICanvasListBox -Name list1 -Choices @('A','B','C')| Property | Type | Values |
|---|---|---|
ItemIcons | String[] | |
Bind * | String | |
DependsOn * | String[] | |
OptionsScript * | ScriptBlock |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
RadioGroup
Mutually exclusive choices as radio buttons.
Cmdlet: Add-UICanvasRadioGroup
Add-UICanvasRadioGroup -Name radio1 -Choices @('Yes','No') -Value 'Yes'| Property | Type | Values |
|---|---|---|
Orientation | String | Vertical | Horizontal |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Checkbox
Boolean with a label.
Cmdlet: Add-UICanvasCheckbox
Add-UICanvasCheckbox 'Enable' -Name chk1 -Value $true| Property | Type | Values |
|---|---|---|
Icon | String | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
CheckBox
Boolean with a label.
Cmdlet: Add-UICanvasCheckbox
Add-UICanvasCheckbox 'Enable' -Name chk1 -Value $true| Property | Type | Values |
|---|---|---|
Icon | String | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Toggle (also ToggleSwitch)
Boolean as a switch.
Cmdlet: Add-UICanvasToggle
Add-UICanvasToggle -Name tgl1 -Value $false| Property | Type | Values |
|---|---|---|
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Rating
Emitted by Add-UICanvasRating.
Cmdlet: Add-UICanvasRating
Add-UICanvasRating -Name rating1| Property | Type | Values |
|---|---|---|
FontSize | Double | |
Max | Int32 |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
ColorPicker
Emitted by Add-UICanvasColorPicker.
Cmdlet: Add-UICanvasColorPicker
Add-UICanvasColorPicker -Name colorpicker1Reads no type-specific properties; the universal keys above still apply.
TimePicker
Emitted by Add-UICanvasTimePicker.
Cmdlet: Add-UICanvasTimePicker
Add-UICanvasTimePicker -Name timepicker1| Property | Type | Values |
|---|---|---|
StepMinutes | Int32 |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Slider
Ranged value.
Cmdlet: Add-UICanvasSlider
Add-UICanvasSlider -Name sld1 -Minimum 0 -Maximum 100 -Value 50| Property | Type | Values |
|---|---|---|
Maximum | Double | |
Minimum | Double | |
Step | Double | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
AutoSuggest
Emitted by Add-UICanvasAutoSuggest.
Cmdlet: Add-UICanvasAutoSuggest
Add-UICanvasAutoSuggest -Name autosuggest1| Property | Type | Values |
|---|---|---|
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
DatePicker (also CalendarView)
Date input.
Cmdlet: Add-UICanvasDatePicker
Add-UICanvasDatePicker -Name date1| Property | Type | Values |
|---|---|---|
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Action
Button
Runs an -Action scriptblock in the app runspace. -NavigateTo is sugar for Show-UICanvasPage.
Cmdlet: Add-UICanvasButton
Add-UICanvasButton 'Button' -Name btn1 -Style Accent -Action { Show-UICanvasToast -Message 'clicked' }| Property | Type | Values |
|---|---|---|
ContentAlign | String | |
GradientFrom | String | |
GradientTo | String | |
Icon | String | |
Style | String | Standard | Secondary | Accent | Primary | Subtle | Gradient |
NavigateTo * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Menu (also MenuBar)
Menu bar from nested @{Text; Items; Action} hashtables.
| Property | Type | Values |
|---|---|---|
Background | String | |
ItemsJson | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Toolbar
Docked app toolbar with brand, links and actions. Links become hidden Event controls with generated names.
| Property | Type | Values |
|---|---|---|
ActionsJson | String | |
Active | String | |
Background | String | |
BarHeight | String | |
Brand | String | |
BrandIcon | String | |
LinksJson | String | |
Status | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Footer
Docked status/footer strip.
| Property | Type | Values |
|---|---|---|
LeftText | String | |
LinksJson | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
DropDownButton (also SplitButton)
Emitted by Add-UICanvasDropDownButton.
Cmdlet: Add-UICanvasDropDownButton
Add-UICanvasDropDownButton 'DropDownButton' -Name dropdownbutton1Reads no type-specific properties; the universal keys above still apply.
Data
ProgressBar
Bound or static progress. -Glow/-GlowPulse for a live indicator.
Cmdlet: Add-UICanvasProgressBar
Add-UICanvasProgressBar -Name prog1 -Value 40 -Glow $true| Property | Type | Values |
|---|---|---|
Fill | String | |
Foreground | String | |
Glow | Object | |
GlowPulse | SwitchParameter | |
GlowRadius | Double | |
Maximum | Double | |
Minimum | Double | |
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Console
Monospace output pane; append with Set-UICanvasProperty <name> AppendLine.
Cmdlet: Add-UICanvasConsole
Add-UICanvasConsole -Name log1 -Height 160| Property | Type | Values |
|---|---|---|
Bind * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Workflow
Engine-native step runner (Add-UICanvasWorkflow -Engine). Steps carry retry/timeout/skip; runner publishes <wf>_status/_pct.
Cmdlet: Add-UICanvasWorkflow
| Property | Type | Values |
|---|---|---|
StepsJson | String | |
Title | String | |
Engine * | SwitchParameter | |
StartLabel * | String | |
StartIcon * | String | |
ShowLog * | SwitchParameter | |
AutoStart * | SwitchParameter | |
LockNavigation * | SwitchParameter | |
LockOnStart * | SwitchParameter | |
StepsHeight * | Int32 | |
Compact * | SwitchParameter | |
NoStartButton * | SwitchParameter | |
NoHeader * | SwitchParameter | |
StateFile * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
DataGrid
Tabular data. Pass rows with -Items (serialised to ItemsJson) or bind with -BindItems.
Cmdlet: Add-UICanvasDataGrid
Add-UICanvasDataGrid -Name grid1 -Columns @('Name','Status') -Items @(@{Name='a';Status='ok'})| Property | Type | Values |
|---|---|---|
Columns | String[] | |
ItemsJson | String | |
Items * | Object[] | |
BindItems * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
TreeView
Hierarchical nodes via -Nodes.
Cmdlet: Add-UICanvasTreeView
Add-UICanvasTreeView -Name tree1 -Nodes @(@{Text='Root';Children=@(@{Text='Child'})})| Property | Type | Values |
|---|---|---|
NodesJson | String | |
Nodes * | Object[] |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
ProgressRing
Indeterminate spinner.
Cmdlet: Add-UICanvasProgressRing
Add-UICanvasProgressRing| Property | Type | Values |
|---|---|---|
Foreground | String | |
Thickness | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
MetricCard
Dashboard KPI tile with trend.
Cmdlet: Add-UICanvasMetricCard
Add-UICanvasMetricCard 'Servers' -Value 12 -Trend Up -Delta '+2'| Property | Type | Values |
|---|---|---|
CornerRadius | String | |
Fill | String | |
Stroke | String | |
StrokeThickness | String | |
Caption * | String | |
Trend * | String | Up | Down | Stable |
Delta * | String | |
Background * | String | |
Foreground * | String | |
FontSize * | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
StatusCard
List of 'Label|State' rows.
Cmdlet: Add-UICanvasStatusCard
Add-UICanvasStatusCard -Title 'Services' -Items @('Web|ok','DB|warn')| Property | Type | Values |
|---|---|---|
CornerRadius | String | |
Fill | String | |
Stroke | String | |
StrokeThickness | String | |
Title * | String | |
Items * | String[] | |
Background * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
TableCard
Small table inside a card.
Cmdlet: Add-UICanvasTableCard
Add-UICanvasTableCard -Title 'Summary' -Columns @('K','V') -Rows @(@('a','1'))| Property | Type | Values |
|---|---|---|
CornerRadius | String | |
Fill | String | |
Stroke | String | |
StrokeThickness | String | |
Title * | String | |
Columns * | String[] | |
Rows * | Object[] | |
Background * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
ChartCard
Bar/Line/Area/Donut/Sparkline. Donut renders a total plus a legend - use a XAML ring for a single reading.
Cmdlet: Add-UICanvasChartCard
Add-UICanvasChartCard -Title 'Trend' -Type Line -Labels @('a','b','c') -Values @(1,3,2)| Property | Type | Values |
|---|---|---|
CornerRadius | String | |
Fill | String | |
Stroke | String | |
StrokeThickness | String | |
Title * | String | |
Labels * | String[] | |
Values * | Double[] | |
Series * | String | |
Type * | String | Bar | Line | Area | Donut | Sparkline |
Datasets * | Object[] | |
Spline * | SwitchParameter | |
Bind * | String | |
Background * | String | |
Foreground * | String | |
ChartHeight * | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Shape
Rectangle
Filled/stroked rectangle. Canvas-layout pages only for X/Y.
Cmdlet: Add-UICanvasRectangle
Add-UICanvasRectangle -X 0 -Y 0 -Width 120 -Height 40 -Fill '#1F3864'| Property | Type | Values |
|---|---|---|
CornerRadius | Double | |
Fill | String | |
Stroke | String | |
StrokeThickness | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Ellipse
Filled/stroked ellipse.
Cmdlet: Add-UICanvasEllipse
Add-UICanvasEllipse -X 0 -Y 0 -Width 60 -Height 60 -Fill '#2FD4E6'| Property | Type | Values |
|---|---|---|
Fill | String | |
Stroke | String | |
StrokeThickness | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Line
Line from X,Y to X2,Y2.
Cmdlet: Add-UICanvasLine
Add-UICanvasLine -X 0 -Y 0 -X2 120 -Y2 0 -Stroke '#94A3B8'| Property | Type | Values |
|---|---|---|
Stroke | String | |
StrokeThickness | Double | |
X2 | Double | |
Y2 | Double |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Escape
Xaml
Raw WPF markup island. {DynamicResource PrimaryBrush} etc. resolve; x:Name'd controls run PowerShell via -Actions. The designer treats the markup as opaque.
Cmdlet: Add-UICanvasXaml
Add-UICanvasXaml -Name island1 -Markup '<Border Width="120" Height="40" Background="{DynamicResource CardBackgroundBrush}"/>'| Property | Type | Values |
|---|---|---|
Markup | String | |
Path | String | |
Actions * | Hashtable |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
Logic
Shortcut
Keyboard gesture bound to an action. No visual.
Cmdlet: Add-UICanvasShortcut - no visual
Add-UICanvasShortcut 'Ctrl+S' -Action { Show-UICanvasToast -Message 'saved' }| Property | Type | Values |
|---|---|---|
Key * | String |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
StateInit
Seeds the reactive state store (New-UICanvasState). No visual.
Cmdlet: New-UICanvasState - no visual
New-UICanvasState @{ counter = 0 }| Property | Type | Values |
|---|---|---|
State * | Hashtable |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
StateWatcher
Runs an action when a state key changes (Watch-UICanvasState). No visual.
Watch-UICanvasState -Key counter -Action { }Reads no type-specific properties; the universal keys above still apply.
Event
A named action fired by toolbar/footer/menu links. Synthesised by those cmdlets; not authored directly.
Cmdlet: Add-UICanvasToolbar - no visual
| Property | Type | Values |
|---|---|---|
Brand * | String | |
BrandIcon * | String | |
Status * | String | |
Links * | String[] | |
Active * | String | |
Actions * | Object[] |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
WindowTemplate
Carries a secondary window's content (New-UICanvasWindow). Opened with Show-UICanvasWindow.
Cmdlet: New-UICanvasWindow - no visual
New-UICanvasWindow -Name dlg1 -Title 'Dialog' -Content { Add-UICanvasLabel 'Hello' }| Property | Type | Values |
|---|---|---|
Title * | String | |
Modal * | SwitchParameter | |
Resizable * | Boolean | |
Topmost * | SwitchParameter | |
MinWidth * | Double | |
MinHeight * | Double | |
Icon * | String | |
Position * | String | CenterOwner | CenterScreen | Manual |
NoScroll * | SwitchParameter | |
HideTitleBar * | SwitchParameter | |
TitleBarColor * | String | |
TitleBarText * | String | |
Layout * | String | Canvas | Stack | VStack | HStack | Grid | Wrap |
Columns * | Int32 | |
Spacing * | Double | |
Padding * | Double | |
Content * | ScriptBlock |
* = a cmdlet parameter the module folds into the bag; the factory reads it under another path.
