@osdk/react-components 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/AGENTS.md +7 -1
  2. package/CHANGELOG.md +6 -0
  3. package/README.md +9 -3
  4. package/build/browser/util/UserAgent.js +1 -1
  5. package/build/cjs/{chunk-BVLPZ4A7.cjs → chunk-FF7DFNVC.cjs} +4 -4
  6. package/build/cjs/{chunk-BVLPZ4A7.cjs.map → chunk-FF7DFNVC.cjs.map} +1 -1
  7. package/build/cjs/{chunk-HYROJGPG.cjs → chunk-GDKDKZ4H.cjs} +4 -4
  8. package/build/cjs/{chunk-HYROJGPG.cjs.map → chunk-GDKDKZ4H.cjs.map} +1 -1
  9. package/build/cjs/{chunk-5DPIS4DA.cjs → chunk-HSA4UIKA.cjs} +4 -4
  10. package/build/cjs/{chunk-5DPIS4DA.cjs.map → chunk-HSA4UIKA.cjs.map} +1 -1
  11. package/build/cjs/{chunk-K2PC2T5C.cjs → chunk-IQZ6IABQ.cjs} +3 -3
  12. package/build/cjs/{chunk-K2PC2T5C.cjs.map → chunk-IQZ6IABQ.cjs.map} +1 -1
  13. package/build/cjs/{chunk-JXYROL4C.cjs → chunk-NFG6NXZN.cjs} +4 -4
  14. package/build/cjs/{chunk-JXYROL4C.cjs.map → chunk-NFG6NXZN.cjs.map} +1 -1
  15. package/build/cjs/public/experimental/action-form.cjs +4 -4
  16. package/build/cjs/public/experimental/filter-list.cjs +6 -6
  17. package/build/cjs/public/experimental/object-table.cjs +6 -6
  18. package/build/cjs/public/experimental/pdf-viewer.cjs +24 -24
  19. package/build/cjs/public/experimental.cjs +37 -37
  20. package/build/esm/util/UserAgent.js +1 -1
  21. package/docs/FilterList.md +5 -4
  22. package/docs/MarkdownRenderer.md +2 -2
  23. package/docs/ObjectTable.md +18 -18
  24. package/docs/PdfViewer.md +10 -7
  25. package/docs/TiffViewer.md +2 -2
  26. package/package.json +3 -3
package/docs/PdfViewer.md CHANGED
@@ -5,7 +5,10 @@ A React component for rendering PDF documents with text selection, custom annota
5
5
  ## Import
6
6
 
7
7
  ```tsx
8
- import { BasePdfViewer, PdfViewer } from "@osdk/react-components/experimental";
8
+ import {
9
+ BasePdfViewer,
10
+ PdfViewer,
11
+ } from "@osdk/react-components/experimental/pdf-viewer";
9
12
  ```
10
13
 
11
14
  - **`PdfViewer`** — Primary component for OSDK usage. Accepts an OSDK `Media` object, handles fetching the PDF contents, and renders the viewer.
@@ -16,7 +19,7 @@ import { BasePdfViewer, PdfViewer } from "@osdk/react-components/experimental";
16
19
  ### With OSDK Media
17
20
 
18
21
  ```tsx
19
- import { PdfViewer } from "@osdk/react-components/experimental";
22
+ import { PdfViewer } from "@osdk/react-components/experimental/pdf-viewer";
20
23
 
21
24
  <PdfViewer media={employee.employeeDocuments} />;
22
25
  ```
@@ -24,7 +27,7 @@ import { PdfViewer } from "@osdk/react-components/experimental";
24
27
  ### With a URL or ArrayBuffer
25
28
 
26
29
  ```tsx
27
- import { BasePdfViewer } from "@osdk/react-components/experimental";
30
+ import { BasePdfViewer } from "@osdk/react-components/experimental/pdf-viewer";
28
31
 
29
32
  // From a URL
30
33
  <BasePdfViewer src="https://example.com/document.pdf" />
@@ -156,7 +159,7 @@ Tier 3: usePdfViewerState / usePdfViewerCore ← custom everything
156
159
 
157
160
  ## Building blocks
158
161
 
159
- All building blocks are exported from `@osdk/react-components/experimental` for composing custom PDF viewer layouts. Use `PdfViewerContent` as the foundation and add whichever chrome you need.
162
+ All building blocks are exported from `@osdk/react-components/experimental/pdf-viewer` for composing custom PDF viewer layouts. Use `PdfViewerContent` as the foundation and add whichever chrome you need.
160
163
 
161
164
  | Component | Description |
162
165
  | -------------------------- | ------------------------------------------------------------------ |
@@ -170,7 +173,7 @@ All building blocks are exported from `@osdk/react-components/experimental` for
170
173
  ### Example: content-only viewer
171
174
 
172
175
  ```tsx
173
- import { PdfViewerContent } from "@osdk/react-components/experimental";
176
+ import { PdfViewerContent } from "@osdk/react-components/experimental/pdf-viewer";
174
177
 
175
178
  <PdfViewerContent
176
179
  src="https://example.com/document.pdf"
@@ -214,7 +217,7 @@ import {
214
217
  PdfViewerSearchBar,
215
218
  PdfViewerToolbar,
216
219
  usePdfViewerState,
217
- } from "@osdk/react-components/experimental";
220
+ } from "@osdk/react-components/experimental/pdf-viewer";
218
221
  import { createPortal } from "react-dom";
219
222
 
220
223
  function MyCustomViewer({ src }: { src: string }) {
@@ -259,7 +262,7 @@ function MyCustomViewer({ src }: { src: string }) {
259
262
  ### Example: minimal viewer with `usePdfViewerCore`
260
263
 
261
264
  ```tsx
262
- import { usePdfViewerCore } from "@osdk/react-components/experimental";
265
+ import { usePdfViewerCore } from "@osdk/react-components/experimental/pdf-viewer";
263
266
 
264
267
  function MinimalViewer({ src }: { src: string }) {
265
268
  const { containerRef, viewerRef, loading, error, currentPage, numPages } =
package/docs/TiffViewer.md CHANGED
@@ -5,13 +5,13 @@ A React component for rendering TIFF images from raw byte arrays.
5
5
  ## Import
6
6
 
7
7
  ```tsx
8
- import { TiffRenderer } from "@osdk/react-components/experimental";
8
+ import { TiffRenderer } from "@osdk/react-components/experimental/tiff-renderer";
9
9
  ```
10
10
 
11
11
  ## Usage
12
12
 
13
13
  ```tsx
14
- import { TiffRenderer } from "@osdk/react-components/experimental";
14
+ import { TiffRenderer } from "@osdk/react-components/experimental/tiff-renderer";
15
15
 
16
16
  <TiffRenderer content={tiffBytes} />;
17
17
  ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/react-components",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "license": "Apache-2.0",
5
5
  "repository": {
6
6
  "type": "git",
@@ -140,9 +140,9 @@
140
140
  "typescript": "~5.5.4",
141
141
  "@osdk/api": "2.11.0",
142
142
  "@osdk/client": "2.11.0",
143
- "@osdk/monorepo.api-extractor": "~0.7.0",
143
+ "@osdk/monorepo.tsconfig": "~0.7.0",
144
144
  "@osdk/react": "0.13.0",
145
- "@osdk/monorepo.tsconfig": "~0.7.0"
145
+ "@osdk/monorepo.api-extractor": "~0.7.0"
146
146
  },
147
147
  "publishConfig": {
148
148
  "access": "public"