API-Referenz von SDK und UI

Die Referenz wird beim Build aus den TSDoc-Kommentaren der Pakete erzeugt, nur über ihre öffentlichen Einstiegspunkte. Anleitungen stehen unter @pithyx/sdk und @pithyx/ui; jeder Fehlercode steht in der Fehlerreferenz.

@pithyx/sdk

• SDK: App und Verbindung: connect(), das Objekt PithyxApp mit allen Methoden, die Formatierer, die Transporte und die Typen des Manifests.
• SDK: Dateien und Speicher: Die Typen der Datei-API: übergebene Dateien, Freigaben, Ordnerseiten, Jobs, Papierkorb, Versionen und Speicheranfragen.
• SDK: Backend: Die Typen rund um app.backend: Status, Tokens, Tickets und der Backend-Teil des Manifests.
• SDK: Ereignisse und Kontext: app.context, jedes Ereignis von app.on und jede Frage von app.answer, mit ihren Daten.
• SDK: i18n: @pithyx/sdk/i18n: createI18n für Texte als ICU-MessageFormat-JSON in der Sprache des Benutzers.
• SDK: Theme: Die öffentlichen CSS-Variablen –pithyx-* und wie das SDK das Theme des Desktops anwendet.
• SDK: Host: @pithyx/sdk/host: die Seite des Desktops im Protokoll, die ein App-Fenster bedient.
• SDK: Fehler: PithyxError, die Form eines Problems und die Fehlercodes des SDK-Transports.

@pithyx/ui

• UI: Button: Button und IconButton in den vier Varianten des Desktops.
• UI: Checkbox: Eine Checkbox mit ihrer Beschriftung.
• UI: Switch: Ein Schalter für Einstellungen, die sofort gelten.
• UI: ProgressBar: Ein beschrifteter Fortschrittsbalken mit seinem Wert als Text.
• UI: Badge: Eine kleine Zahl oder ein Status neben einem Element.
• UI: Dialog: Ein modaler Dialog mit Titel, Inhalt und einer Reihe von Aktionen.
• UI: Menu: Menu mit Einträgen, Trennlinien, Popover und Auslöser, dazu useDeliberatePress für destruktive Einträge.
• UI: ContextMenuPopover: Das Popover eines Kontextmenüs, geöffnet an einem Punkt des Viewports.
• UI: TextField: Ein beschriftetes Texteingabefeld mit optionaler Beschreibung und Fehlermeldung.
• UI: PasswordField: Ein Passwortfeld mit einem Knopf, der das Passwort zeigt oder verbirgt.
• UI: SearchField: Ein Suchfeld, dessen Beschriftung nur vorgelesen wird.
• UI: OtpField: Ein Feld für den sechsstelligen Code einer Authenticator-App.
• UI: Tooltip: Ein kurzer Text neben seinem Auslöser, mit TooltipTrigger.
• UI: UiProvider: Setzt die Locale der Komponenten und ihrer eigenen Texte.
• UI: Helpers: cx und die Texte, die die Komponenten selbst zeigen.
• UI: native: @pithyx/ui/native: die Klassennamen der Komponenten für native HTML-Elemente, ohne React Aria.
• UI: Tokens: Jedes Design-Token von @pithyx/ui/tokens.css mit seinem Wert, die Akzent-Vorgaben und die Media-Overrides.