freebrowse 2.5.0-next.1 → 2.5.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 (8) hide show
  1. package/README.md +5 -6
  2. package/dist-lib/index.js +2543 -2528
  3. package/dist-lib/index.js.map +1 -1
  4. package/dist-lib/react.js +1099 -1084
  5. package/dist-lib/react.js.map +1 -1
  6. package/dist-lib/style.css +1 -1
  7. package/dist-lib/types/lib/default-niivue-options.d.ts +13 -1
  8. package/package.json +4 -4
package/README.md CHANGED
@@ -6,11 +6,10 @@ controls. Full project documentation: https://github.com/freesurfer/freebrowse
6
6
 
7
7
  ## Embedding FreeBrowse in your own app (npm package)
8
8
 
9
- FreeBrowse is published to npm as `freebrowse`. Until the niivue-mono migration lands on
10
- `main` it is available under the `next` dist-tag only:
9
+ FreeBrowse is published to npm as `freebrowse`:
11
10
 
12
11
  ```bash
13
- npm install freebrowse@next @niivue/niivue@1.0.0-rc.13
12
+ npm install freebrowse @niivue/niivue@1.0.0-rc.38
14
13
  ```
15
14
 
16
15
  `@niivue/niivue` is a peer dependency: **you** create the NiiVue instance, FreeBrowse renders
@@ -60,14 +59,14 @@ The handle returned has `nv` and `destroy()`. **One mount at a time**: FreeBrows
60
59
  single store, so a second concurrent mount throws; destroy the first one. Styles are scoped to
61
60
  the mounted element (`.freebrowse-root`) and never touch your page's `html`/`body`; import
62
61
  `freebrowse/style.css` once. Working examples for both entries live in
63
- [`frontend/examples/`](https://github.com/freesurfer/freebrowse/tree/main/frontend/examples/).
62
+ [`frontend/examples/`](https://github.com/freesurfer/freebrowse/tree/main/frontend/examples/); they install `freebrowse` from npm.
64
63
 
65
64
  Releasing (maintainers): bump `version` in `frontend/package.json` (the app and the package
66
- share it; pre-merge builds use a `-next.N` suffix), then from `frontend/`:
65
+ share it), then from `frontend/`:
67
66
 
68
67
  ```bash
69
68
  npm run build:package && npm run pack:check # publint + arethetypeswrong on the tarball
70
- npm publish --tag next # `latest` is reserved for the main-branch release
69
+ npm publish # a `-next.N` pre-release: npm publish --tag next
71
70
  ```
72
71
 
73
72
  ## Driving FreeBrowse from your own code