# SDK and UI API reference

> The generated API reference of @pithyx/sdk and @pithyx/ui, one page per module and per component.

Source: https://pithyx.org/docs/reference/sdk/
Markdown: https://pithyx.org/docs/reference/sdk.md

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](https://pithyx.org/docs/sdk/sdk/) and [@pithyx/ui](https://pithyx.org/docs/sdk/ui/); every error code is in the [error reference](https://pithyx.org/docs/reference/errors/).

## @pithyx/sdk

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

## @pithyx/ui

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