SDK and UI API reference

The reference is generated from the TSDoc comments of the packages at build time, through their public entry points only. Guides are on @pithyx/sdk and @pithyx/ui; every error code is in the error reference.

@pithyx/sdk

• SDK: app and connection: connect(), the PithyxApp object with every method, the formatters, the transports and the manifest types.
• SDK: files and storage: The types of the file API: handed-over files, shares, folder pages, jobs, the recycle bin, versions and storage requests.
• SDK: backend: The types around app.backend: status, tokens, tickets and the backend part of the manifest.
• SDK: events and context: app.context, every event of app.on and every question of app.answer, with their data.
• SDK: i18n: @pithyx/sdk/i18n: createI18n for texts as ICU MessageFormat JSON in the user language.
• SDK: theme: The public –pithyx-* CSS custom properties and how the SDK applies the desktop theme.
• SDK: host: @pithyx/sdk/host: the desktop’s side of the protocol, which serves an app window.
• SDK: errors: PithyxError, the problem shape and the SDK transport error codes.

@pithyx/ui

• UI: Button: Button and IconButton, in the four variants of the desktop.
• UI: Checkbox: A checkbox with its label.
• UI: Switch: An on and off switch for settings that apply at once.
• UI: ProgressBar: A labelled progress bar with its value as text.
• UI: Badge: A small count or status next to an item.
• UI: Dialog: A modal dialog with a title, content and a row of actions.
• UI: Menu: Menu, its items, separators, popover and trigger, and useDeliberatePress for destructive items.
• UI: ContextMenuPopover: The popover of a context menu, opened at a point of the viewport.
• UI: TextField: A labelled text input with an optional description and error message.
• UI: PasswordField: A password input with a button that shows or hides the password.
• UI: SearchField: A search input whose label is only announced.
• UI: OtpField: An input for the six-digit code of an authenticator app.
• UI: Tooltip: A short text next to its trigger, with TooltipTrigger.
• UI: UiProvider: Sets the locale of the components and their own texts.
• UI: Helpers: cx and the texts the components show on their own.
• UI: native: @pithyx/ui/native: the class names of the components for native HTML elements, without React Aria.
• UI: tokens: Every design token of @pithyx/ui/tokens.css with its value, the accent presets and the media overrides.