https://github.com/pionjs/pion
React's Hooks API implemented for web components
https://github.com/pionjs/pion
hooks lit-html react-hooks web-component web-components
Last synced: about 1 month ago
JSON representation
React's Hooks API implemented for web components
- Host: GitHub
- URL: https://github.com/pionjs/pion
- Owner: pionjs
- License: bsd-2-clause
- Created: 2023-09-20T08:28:50.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T10:41:16.000Z (about 1 year ago)
- Last Synced: 2025-07-05T06:08:17.949Z (12 months ago)
- Topics: hooks, lit-html, react-hooks, web-component, web-components
- Language: TypeScript
- Homepage: https://pionjs.com
- Size: 1.96 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pion
[](https://npm.im/@pionjs/pion)
[](https://npm.im/@pionjs/pion)
React's Hooks API but for standard web components and [lit-html](https://lit-html.polymer-project.org/) or [hyperHTML](https://codepen.io/WebReflection/pen/pxXrdy?editors=0010).
Forked from [haunted](https://github.com/matthewp/haunted).
📚 [Read the Docs](https://pionjs.com) 📖
```html
import { html } from 'https://unpkg.com/lit?module';
import { component, useState } from 'https://unpkg.com/@pionjs/pion';
function Counter() {
const [count, setCount] = useState(0);
return html`
<div id="count">${count}</div>
<button type="button" @click=${() => setCount(count + 1)}>
Increment
</button>
`;
}
customElements.define('my-counter', component(Counter));
```
More example integrations can be found in [this gist](https://gist.github.com/matthewp/92c4daa6588eaef484c6f389d20d5700).
## Hooks
pion supports the same API as React Hooks. The hope is that by doing so you can reuse hooks available on npm simply by aliasing package names in your bundler's config.
Currently pion supports the following hooks:
- [useCallback](https://pionjs.com/docs/hooks/useCallback/)
- [useContext](https://pionjs.com/docs/hooks/useContext/)
- [useEffect](https://pionjs.com/docs/hooks/useEffect/)
- [useLayoutEffect](https://pionjs.com/docs/hooks/useLayoutEffect/)
- [useMemo](https://pionjs.com/docs/hooks/useMemo/)
- [useReducer](https://pionjs.com/docs/hooks/useReducer/)
- [useRef](https://pionjs.com/docs/hooks/useRef/)
- [useState](https://pionjs.com/docs/hooks/useState/)
### Function Signatures
```ts
// Or another renderer, see Guides
type Renderer = (element: Element) => TemplateResult;
interface Options {
baseElement: HTMLElement;
observedAttributes: string[];
useShadowDOM: boolean
}
declare function component(
renderer: Renderer,
options: Options
): Element;
declare function component(
renderer: Renderer,
baseElement: BaseElement,
options: Options
): Element
declare function virtual(renderer: Renderer): Directive
```
## License
BSD-2-Clause