@namehash/namehash-ui 1.13.1 → 1.14.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 -4
  2. package/dist/index.cjs +548 -164
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +720 -23
  5. package/dist/index.d.ts +720 -23
  6. package/dist/index.js +543 -150
  7. package/dist/index.js.map +1 -1
  8. package/package.json +10 -9
package/README.md CHANGED
@@ -2,15 +2,16 @@
2
2
 
3
3
  The contained UI components are for reuse across multiple apps developed by the NameHash Labs team, but are highly opinionated according to our specific apps and therefore aren't intended for the general public.
4
4
 
5
- For UI component libraries intended for the general public, we recommend [ensnode-react](https://www.npmjs.com/package/@ensnode/ensnode-react).
5
+ This package also exports various React providers and hooks (e.g. `EnsNodeProvider`, `useRecords`, `usePrimaryName`, `usePrimaryNames`, `useResolvedIdentity`, `useIndexingStatus`, `useRegistrarActions`, `useNameTokens`, `useSwrQuery`, etc.).
6
6
 
7
7
  ## Installation
8
8
 
9
9
  ```bash
10
- npm install @namehash/namehash-ui @ensnode/ensnode-react sonner
10
+ npm install @namehash/namehash-ui @tanstack/react-query sonner
11
11
  ```
12
12
 
13
- Note: `@ensnode/ensnode-react` and `sonner` are package's peer dependencies. The former is necessary only for some components and same goes for `sonner` which is only necessary for `CopyButton` component. It might happen that you won't need these installed, depending on which components you want to use.
13
+ > [!NOTE]
14
+ > `@tanstack/react-query` and `sonner` are peer dependencies. `@tanstack/react-query` is required when using the hooks/providers exported from this package; `sonner` is only required for the `CopyButton` component. Depending on which components you use, you may not need both installed.
14
15
 
15
16
  ## Setup
16
17
 
@@ -20,4 +21,4 @@ Make sure you import the `styles.css` file somewhere in your app:
20
21
 
21
22
  ```tsx
22
23
  import "@namehash/namehash-ui/styles.css";
23
- ```
24
+ ```