Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

recoil-sync-next

Package Overview
Dependencies
Maintainers
2
Versions
6
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

recoil-sync-next

recoil-sync stores for Next.js

  • 0.0.6
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.1K
increased by15.24%
Maintainers
2
Weekly downloads
 
Created
Source

recoil-sync-next

npm version

Recoil Sync stores for Next.js

Caution

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

Features

Installation

npm install recoil recoil-sync recoil-sync-next
# or
yarn add recoil recoil-sync recoil-sync-next
# or
pnpm 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>.

function RecoilURLSyncJSONNext(props: {
  storeKey?: string | undefined
  location: LocationOption
  children: ReactNode
}): ReactNode
Props
  • storeKey
  • 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
import { RecoilURLSyncJSONNext } from 'recoil-sync-next'

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <RecoilRoot>
      <RecoilURLSyncJSONNext location={{ part: 'queryParams' }}>
        <Component {...pageProps} />
      </RecoilURLSyncJSONNext>
    </RecoilRoot>
  )
}

<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>.

function RecoilURLSyncTransitNext(props: {
  storeKey?: string | undefined
  location: LocationOption
  handlers?: ReadonlyArray<TransitHandler<any, any>>
  children: ReactNode
}): ReactNode
Props
  • storeKey
  • 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
import { RecoilURLSyncTransitNext } from 'recoil-sync-next'

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <RecoilRoot>
      <RecoilURLSyncTransitNext location={{ part: 'queryParams' }}>
        <Component {...pageProps} />
      </RecoilURLSyncTransitNext>
    </RecoilRoot>
  )
}

<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>.

function RecoilURLSyncNext(props: {
  storeKey?: string | undefined
  location: LocationOption
  serialize: (data: unknown) => string
  deserialize: (str: string) => unknown
  children: ReactNode
}): ReactNode
Props
  • storeKey
  • location
    • This prop specifies what part of the URL to sync. See URL Location for more info.
  • serialize
  • deserialize
  • children
    • React elements in your component tree.
Example
import { RecoilURLSyncNext } from 'recoil-sync-next'
import qs from 'qs'

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <RecoilRoot>
      <RecoilURLSyncNext
        location={{ part: 'queryParams' }}
        serialize={qs.stringify}
        deserialize={qs.parse}
      >
        <Component {...pageProps} />
      </RecoilURLSyncNext>
    </RecoilRoot>
  )
}

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>.

function RecoilHistorySyncJSONNext(props: {
  storeKey?: string | undefined
  children: ReactNode
}): ReactNode
Props
  • storeKey
  • children
    • React elements in your component tree.
Example
import { RecoilHistorySyncJSONNext } from 'recoil-sync-next'

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <RecoilRoot>
      <RecoilHistorySyncJSONNext>
        <Component {...pageProps} />
      </RecoilHistorySyncJSONNext>
    </RecoilRoot>
  )
}

<RecoilHistorySyncTransitNext>

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

function RecoilHistorySyncTransitNext(props: {
  storeKey?: string | undefined
  handlers?: ReadonlyArray<TransitHandler<any, any>>
  children: ReactNode
}): ReactNode
Props
  • storeKey
  • handlers
    • The array of user defined custom encoder/decoder object. See Custom Classes for more info.
  • children
    • React elements in your component tree.
Example
import { RecoilHistorySyncTransitNext } from 'recoil-sync-next'

function MyApp({ Component, pageProps }: AppProps) {
  return (
    <RecoilRoot>
      <RecoilHistorySyncTransitNext>
        <Component {...pageProps} />
      </RecoilHistorySyncTransitNext>
    </RecoilRoot>
  )
}

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.

function initializableAtom<T extends SerializableParam>(options: {
  key: string
  effects?:
    | ReadonlyArray<AtomEffect<T>>
    | ((param: P) => ReadonlyArray<AtomEffect<T>>)
  dangerouslyAllowMutability?: boolean
}): (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
import { initializableAtom } from 'recoil-sync-next'

const countState = initializableAtom<number>({
  key: 'count',
})

const MyComponent: React.FC = () => {
  const [count, setCount] = useRecoilState(countState(100)) // count is initialized to 100
  ...
}

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.

function initializableAtomFamily<
  T extends SerializableParam,
  P extends SerializableParam
>(options: {
  key: string
  effects?:
    | ReadonlyArray<AtomEffect<T>>
    | ((param: P) => ReadonlyArray<AtomEffect<T>>)
  dangerouslyAllowMutability?: boolean
}): (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
import { initializableAtomFamily } from 'recoil-sync-next'

const countState = initializableAtomFamily<number, string>({
  key: 'count',
})

const MyComponent: React.FC = () => {
  const [count1, setCount1] = useRecoilState(countState('foo', 0))   // count1 is initialized to 0
  const [count2, setCount2] = useRecoilState(countState('bar', 100)) // count2 is initialized to 100
  ...
}

Keywords

FAQs

Package last updated on 22 Apr 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc