OSDK TypeScript
Documentation for the OSDK TypeScript packages.
Packages
@osdk/react
React hooks for building front-end applications with OSDK.
- Prerequisites - Installation and setup
- Getting Started - First app walkthrough
- Querying Data - useOsdkObjects, useOsdkObject, useLinks
- Actions - useOsdkAction, validation, optimistic updates
- Advanced Queries - useObjectSet, derived properties, aggregations
- Cache Management - Cache behavior and invalidation
- Platform APIs - useCurrentFoundryUser, useFoundryUser, useFoundryUsersList
Components
Pre-built, Ontology-aware React components with data loading, caching, and state management.
- Prerequisites - Installation, CSS layers, and theming setup
- ObjectTable - Sortable, filterable table with inline editing
- FilterList - Aggregation-based filter UI
- PdfViewer - PDF viewer with annotations and search
- CbacPicker - Classification marking picker, dialog, and banner
Other Guides
- Using OSDK with Vite - Fixing common Vite configuration issues