recoil-sync-next

Recoil Sync stores for Next.js

Caution

The new router for the app/ directory introduced by Next.js 13 is not yet supported.

Features

• URL Persistence
  • Syncing an atom with the browser URL.
• Session Storage Persistence Synced with History
  • Syncing an atom with the history position.
• Utilities

Installation

1npm install recoil recoil-sync recoil-sync-next
2# or
3yarn add recoil recoil-sync recoil-sync-next
4# or
5pnpm add recoil recoil-sync recoil-sync-next

URL Persistence

This provides recoil-sync's URL Persistence functionality interfaced with next/router.

Notes

<RecoilURLSyncJSON> and <RecoilURLSyncTransit> always use shallow routing to update the browser URL. When the URL has changed, they cause re-rendering of themselves. Therefore, you should concider to use React.memo() for Page components that use URL synced atoms ( example ).

<RecoilURLSyncJSONNext>

A version of <RecoilURLSyncJSON> that works with next/router to sync atoms with the browser URL using JSON encoding. This should be a child element of <RecoilRoot>.

1function RecoilURLSyncJSONNext(props: {
2  storeKey?: string | undefined
3  location: LocationOption
4  children: ReactNode
5}): ReactNode

Props

• storeKey
  • This prop is used to match up which atoms should sync with this external store. See Syncing with Multiple Storages for more info.
• location
  • Tis prop specifies what part of the URL to sync. See URL Location for more info.
• children
  • React elements in your component tree.

Example

1import { RecoilURLSyncJSONNext } from 'recoil-sync-next'
2
3function MyApp({ Component, pageProps }: AppProps) {
4  return (
5    <RecoilRoot>
6      <RecoilURLSyncJSONNext location={{ part: 'queryParams' }}>
7        <Component {...pageProps} />
8      </RecoilURLSyncJSONNext>
9    </RecoilRoot>
10  )
11}

<RecoilURLSyncTransitNext>

A version of <RecoilURLSyncTransit> that works with next/router to sync atoms with the browser URL using Transit encoding. This should be a child element of <RecoilRoot>.

1function RecoilURLSyncTransitNext(props: {
2  storeKey?: string | undefined
3  location: LocationOption
4  handlers?: ReadonlyArray<TransitHandler<any, any>>
5  children: ReactNode
6}): ReactNode

Props

• storeKey
  • This prop is used to match up which atoms should sync with this external store. See Syncing with Multiple Storages for more info.
• location
  • Tis prop specifies what part of the URL to sync. See URL Location for more info.
• handlers
  • The array of user defined custom encoder/decoder object. See Custom Classes for more info.
• children
  • React elements in your component tree.

Example

1import { RecoilURLSyncTransitNext } from 'recoil-sync-next'
2
3function MyApp({ Component, pageProps }: AppProps) {
4  return (
5    <RecoilRoot>
6      <RecoilURLSyncTransitNext location={{ part: 'queryParams' }}>
7        <Component {...pageProps} />
8      </RecoilURLSyncTransitNext>
9    </RecoilRoot>
10  )
11}

<RecoilURLSyncNext>

A version of <RecoilURLSync> that works with next/router to sync atoms with the browser URL using your own serialize/deserialize algorithms. This should be a child element of <RecoilRoot>.

1function RecoilURLSyncNext(props: {
2  storeKey?: string | undefined
3  location: LocationOption
4  serialize: (data: unknown) => string
5  deserialize: (str: string) => unknown
6  children: ReactNode
7}): ReactNode

Props

• storeKey
  • This prop is used to match up which atoms should sync with this external store. See Syncing with Multiple Storages for more info.
• location
  • This prop specifies what part of the URL to sync. See URL Location for more info.
• serialize
  • The callback can provide custom serializations. See Custom serialization for more info.
• deserialize
  • The callback can provide custom deserializations. See Custom serialization for more info.
• children
  • React elements in your component tree.

Example

1import { RecoilURLSyncNext } from 'recoil-sync-next'
2import qs from 'qs'
3
4function MyApp({ Component, pageProps }: AppProps) {
5  return (
6    <RecoilRoot>
7      <RecoilURLSyncNext
8        location={{ part: 'queryParams' }}
9        serialize={qs.stringify}
10        deserialize={qs.parse}
11      >
12        <Component {...pageProps} />
13      </RecoilURLSyncNext>
14    </RecoilRoot>
15  )
16}

Session Storage Persistence Synced with History

Provides persistence of atoms to session storage synced with the position of the history entry. It will save atoms to session storage when the history entry's position is moved. When the user moves backward/forward on history entries (i.e. 'popstate' event is fired), the atoms saved with that position is restored.

<RecoilHistorySyncJSONNext>

To sync atoms with the position of the history entry using JSON encoding. This should be a child element of <RecoilRoot>.

1function RecoilHistorySyncJSONNext(props: {
2  storeKey?: string | undefined
3  children: ReactNode
4}): ReactNode

Props

• storeKey
  • This prop is used to match up which atoms should sync with this external store. See Syncing with Multiple Storages for more info.
• children
  • React elements in your component tree.

Example

1import { RecoilHistorySyncJSONNext } from 'recoil-sync-next'
2
3function MyApp({ Component, pageProps }: AppProps) {
4  return (
5    <RecoilRoot>
6      <RecoilHistorySyncJSONNext>
7        <Component {...pageProps} />
8      </RecoilHistorySyncJSONNext>
9    </RecoilRoot>
10  )
11}

<RecoilHistorySyncTransitNext>

To sync atoms with the position of the history entry using Transit encoding. This should be a child element of <RecoilRoot>.

1function RecoilHistorySyncTransitNext(props: {
2  storeKey?: string | undefined
3  handlers?: ReadonlyArray<TransitHandler<any, any>>
4  children: ReactNode
5}): ReactNode

Props

• storeKey
  • This prop is used to match up which atoms should sync with this external store. See Syncing with Multiple Storages for more info.
• handlers
  • The array of user defined custom encoder/decoder object. See Custom Classes for more info.
• children
  • React elements in your component tree.

Example

1import { RecoilHistorySyncTransitNext } from 'recoil-sync-next'
2
3function MyApp({ Component, pageProps }: AppProps) {
4  return (
5    <RecoilRoot>
6      <RecoilHistorySyncTransitNext>
7        <Component {...pageProps} />
8      </RecoilHistorySyncTransitNext>
9    </RecoilRoot>
10  )
11}

Utilities

initializableAtom

atom, but initial value can be specified when using it.

Note: This is just a utility and does not depend on either Recoil Sync or Next.js.

1function initializableAtom<T extends SerializableParam>(options: {
2  key: string
3  effects?:
4    | ReadonlyArray<AtomEffect<T>>
5    | ((param: P) => ReadonlyArray<AtomEffect<T>>)
6  dangerouslyAllowMutability?: boolean
7}): (initialValue: T) => RecoilState<T>

Type Parameters

• T
  • The type of the atom value. It must be compared using value-equality and must be serializable.

Parameters

See atom for more info.

Return

A function which takes its initialValue.

Example

1import { initializableAtom } from 'recoil-sync-next'
2
3const countState = initializableAtom<number>({
4  key: 'count',
5})
6
7const MyComponent: React.FC = () => {
8  const [count, setCount] = useRecoilState(countState(100)) // count is initialized to 100
9  ...
10}

initializableAtomFamily

atomFamily, but initial value can be specified individually when using it.

Note: This is just a utility and does not depend on either Recoil Sync or Next.js.

1function initializableAtomFamily<
2  T extends SerializableParam,
3  P extends SerializableParam
4>(options: {
5  key: string
6  effects?:
7    | ReadonlyArray<AtomEffect<T>>
8    | ((param: P) => ReadonlyArray<AtomEffect<T>>)
9  dangerouslyAllowMutability?: boolean
10}): (parameter: P, initialValue: T) => RecoilState<T>

Type Parameters

• T
  • The type of the atom value. It must be compared using value-equality and must be serializable.
• P
  • The type of the paramter that map to each atom. It must be compared using value-equality and must be serializable.

Parameters

See atomFamily for more info.

Return

A function which takes parameter that map to an atom, and its initialValue.

Example

1import { initializableAtomFamily } from 'recoil-sync-next'
2
3const countState = initializableAtomFamily<number, string>({
4  key: 'count',
5})
6
7const MyComponent: React.FC = () => {
8  const [count1, setCount1] = useRecoilState(countState('foo', 0))   // count1 is initialized to 0
9  const [count2, setCount2] = useRecoilState(countState('bar', 100)) // count2 is initialized to 100
10  ...
11}