db906fd85a
- Replace .eslintrc.cjs with eslint.config.mjs (ESLint 9 flat config)
using direct eslint-plugin-solid + @typescript-eslint/parser approach
- Add @typescript-eslint/parser to root devDependencies
- Add main/module/types top-level fields to packages/core/package.json
- Add resolve.conditions to packages/core/vite.config.ts
- Create packages/core/tsconfig.test.json for test type-checking
- Remove empty paths:{} from packages/core/tsconfig.json
151 lines
5.1 KiB
Markdown
151 lines
5.1 KiB
Markdown
Context
|
|
|
|
# Context
|
|
|
|
Context
|
|
|
|
Context
|
|
|
|
Context
|
|
|
|
Size
|
|
|
|
263 B
|
|
[NPM\\
|
|
\\
|
|
v0.3.1](https://www.npmjs.com/package//@solid-primitives/context)
|
|
Stage
|
|
|
|
2
|
|
|
|
## [\#](https://primitives.solidjs.community/package/context/\#installation) Installation
|
|
|
|
Copy
|
|
|
|
npm install @solid-primitives/context
|
|
|
|
Copy
|
|
|
|
yarn add @solid-primitives/context
|
|
|
|
Copy
|
|
|
|
pnpm add @solid-primitives/context
|
|
|
|
## [\#](https://primitives.solidjs.community/package/context/\#readme) Readme
|
|
|
|
Primitives simplifying the creation and use of SolidJS Context API.
|
|
|
|
- [`createContextProvider`](https://primitives.solidjs.community/package/context/#createcontextprovider) \- Create the Context Provider component and useContext function with types inferred from the factory function.
|
|
- [`MultiProvider`](https://primitives.solidjs.community/package/context/#multiprovider) \- A component that allows you to provide multiple contexts at once.
|
|
|
|
## [\#](https://primitives.solidjs.community/package/context/\#createcontextprovider)`createContextProvider`
|
|
|
|
Create the Context Provider component and useContext function with types inferred from the factory function.
|
|
|
|
### [\#](https://primitives.solidjs.community/package/context/\#how-to-use-it) How to use it
|
|
|
|
Given a factory function, `createContextProvider` creates a SolidJS Context and returns both a Provider component for setting the context, and a useContext helper for getting the context. The factory function gets called when the provider component gets executed; all `props` of the provider component get passed into the factory function, and what it returns will be available in the contexts for all the underlying components. The types of the provider props and context are inferred from the factory function.
|
|
|
|
```tsx
|
|
import { createContextProvider } from "@solid-primitives/context";
|
|
|
|
const [CounterProvider, useCounter] = createContextProvider((props: { initial: number }) => {
|
|
const [count, setCount] = createSignal(props.initial);
|
|
const increment = () => setCount(count() + 1);
|
|
return { count, increment };
|
|
});
|
|
|
|
// Provide the context
|
|
<CounterProvider initial={1}>
|
|
<App />
|
|
</CounterProvider>;
|
|
|
|
// Use the context in a child component
|
|
const ctx = useCounter();
|
|
ctx; // T: { count: () => number; increment: () => void; } | undefined
|
|
```
|
|
|
|
### [\#](https://primitives.solidjs.community/package/context/\#providing-context-fallback) Providing context fallback
|
|
|
|
The `createContextProvider` primitive takes a second, optional argument for providing context defaults for when the context wouldn't be provided higher in the component tree.
|
|
Providing a fallback also removes `undefined` from `T | undefined` return type of the `useContext` function.
|
|
|
|
```ts
|
|
const [CounterProvider, useCounter] = createContextProvider(
|
|
() => {
|
|
const [count, setCount] = createSignal(0);
|
|
const increment = () => setCount(count() + 1);
|
|
return { count, increment };
|
|
},
|
|
{
|
|
count: () => 0,
|
|
increment: () => {},
|
|
},
|
|
);
|
|
|
|
// then when using the context:
|
|
const { count } = useCounter();
|
|
```
|
|
|
|
Definite context types without defaults:
|
|
|
|
```ts
|
|
const useDefiniteCounter = () => useCounter()!;
|
|
```
|
|
|
|
### [\#](https://primitives.solidjs.community/package/context/\#demo) Demo
|
|
|
|
[https://codesandbox.io/s/solid-primitives-context-demo-oqyie2?file=/index.tsx](https://codesandbox.io/s/solid-primitives-context-demo-oqyie2?file=/index.tsx)
|
|
|
|
## [\#](https://primitives.solidjs.community/package/context/\#multiprovider)`MultiProvider`
|
|
|
|
A component that allows you to provide multiple contexts at once.
|
|
|
|
It will work exactly like nesting multiple providers as separate components, but it will save you from the nesting.
|
|
|
|
### [\#](https://primitives.solidjs.community/package/context/\#how-to-use-it-1) How to use it
|
|
|
|
`MultiProvider` takes only a single `values` with a key-value pair of the context and the value to provide.
|
|
|
|
> **Note**
|
|
> Values list is evaluated in order, so the context values will be provided in the same way as if you were nesting the providers.
|
|
|
|
```tsx
|
|
import { MultiProvider } from "@solid-primitives/context";
|
|
|
|
// before
|
|
<FooContext.Provider value={"foo"}>
|
|
<BarContext.Provider value={"bar"}>
|
|
<BazContext.Provider value={"baz"}>
|
|
<MyCustomProviderComponent value={"hello-world"}>
|
|
<BoundContextProvider>
|
|
<App />
|
|
</BoundContextProvider>
|
|
</MyCustomProviderComponent>
|
|
</BazContext.Provider>
|
|
</BarContext.Provider>
|
|
</FooContext.Provider>;
|
|
|
|
// after
|
|
<MultiProvider
|
|
values={[\
|
|
[FooContext, "foo"],\
|
|
[BarContext, "bar"],\
|
|
[BazContext, "baz"],\
|
|
// you can also provide a component, the value will be passed to a `value` prop\
|
|
[MyCustomProviderComponent, "hello-world"],\
|
|
// if you have a provider that doesn't accept a `value` prop, you can just pass a function\
|
|
BoundContextProvider,\
|
|
]}
|
|
>
|
|
<App />
|
|
</MultiProvider>;
|
|
```
|
|
|
|
> **Warning**
|
|
> Components and values passed to `MultiProvider` will be evaluated only once, so make sure that the structure is static. If is isn't, please use nested provider components instead.
|
|
|
|
## [\#](https://primitives.solidjs.community/package/context/\#changelog) Changelog
|
|
|
|
See [CHANGELOG.md](https://github.com/solidjs-community/solid-primitives/blob/main/packages/context/CHANGELOG.md) |