Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ preview assets supplied by the host app; it never signs URLs, reads tokens, or
parses provider-specific IDs.

```tsx
import { PreviewShell } from '@numeracode/whimsy-file-browser';
import { PreviewShell } from '@numeracode/whimsy-file-browser/preview';

export function MyPreview({ item }) {
return (
Expand All @@ -68,6 +68,10 @@ Use the same `PreviewShell` from filebrowser, spaces, showcase, dedupe, and any
gallery surface. Whimsy remains responsible for auth, permission checks, and
signed manifest generation.

Prefer the `/preview` subpath for preview-only integrations. It avoids loading
the legacy browser/redux runtime when a host app only needs tile, shell,
renderer, or lightbox primitives.

## Development

```bash
Expand Down
10 changes: 5 additions & 5 deletions packages/chonky/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ export function MyBrowser() {

## Provider-agnostic previews

Use `PreviewShell`, `FilePreviewer`, `PreviewTile`, and `MediaLightbox` for new
preview integrations. The package renders manifests and signed URLs supplied by
the host app; it does not include Whimsy auth, provider credentials, or signing
logic.
Use `PreviewShell`, `FilePreviewer`, `PreviewTile`, and `MediaLightbox` from the
preview-only subpath for new preview integrations. The package renders
manifests and signed URLs supplied by the host app; it does not include Whimsy
auth, provider credentials, or signing logic.

```tsx
import { MediaLightbox, PreviewTile } from '@numeracode/whimsy-file-browser';
import { MediaLightbox, PreviewTile } from '@numeracode/whimsy-file-browser/preview';

export function PreviewExample({ item, open, setOpen }) {
return (
Expand Down
9 changes: 7 additions & 2 deletions packages/chonky/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"require": "./dist/index.js"
},
"./preview": {
"types": "./dist/preview.d.ts",
"import": "./dist/preview.mjs",
"require": "./dist/preview.js"
}
},
"files": [
Expand All @@ -25,9 +30,9 @@
"node": ">=20"
},
"scripts": {
"build": "tsup src/index.ts --format cjs,esm --dts --sourcemap --clean --external react --external react-dom",
"build": "tsup src/index.ts src/preview.ts --format cjs,esm --dts --sourcemap --clean --external react --external react-dom",
"clean": "rm -rf dist",
"dev": "tsup src/index.ts --format cjs,esm --dts --sourcemap --watch --external react --external react-dom",
"dev": "tsup src/index.ts src/preview.ts --format cjs,esm --dts --sourcemap --watch --external react --external react-dom",
"lint": "npm run typecheck",
"test": "vitest run --passWithNoTests --globals --environment jsdom",
"typecheck": "tsc -p tsconfig.json --noEmit"
Expand Down
40 changes: 40 additions & 0 deletions packages/chonky/src/preview.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
export { FilePreviewer, defaultPreviewRenderers } from './components/preview/FilePreviewer';
export { MediaLightbox } from './components/preview/MediaLightbox';
export { PreviewFallback } from './components/preview/PreviewFallback';
export { PreviewShell } from './components/preview/PreviewShell';
export { PreviewTile } from './components/preview/PreviewTile';
export { createBrowserOpaqueId } from './types/browser-item.types';
export type {
BrowserItem,
BrowserItemCapabilities,
BrowserItemFlags,
BrowserItemKind,
BrowserItemRef,
BrowserMetadataValue,
BrowserOpaqueId,
BrowserPreviewAsset,
BrowserPreviewAssetKind,
BrowserPreviewRenderer,
BrowserPreviewTrack,
BrowserPreviewTrackKind,
BrowserPreviewUnavailableReason,
BrowserSourceDescriptor,
BrowserSourceKind,
PreviewDescriptor,
} from './types/browser-item.types';
export type {
AvailableBrowserPreviewAsset,
FilePreviewerProps,
LazyPreviewRenderer,
MediaLightboxProps,
PreviewFallbackProps,
PreviewManifestLoader,
PreviewRendererComponent,
PreviewRendererEntry,
PreviewRendererModule,
PreviewRendererProps,
PreviewRendererRegistry,
PreviewRequest,
PreviewShellProps,
PreviewTileProps,
} from './types/preview-shell.types';
Loading