Skip to content

use-channel.md

Latest commit

 

History

History
39 lines (26 loc) · 1.04 KB

use-channel.md

File metadata and controls

39 lines (26 loc) · 1.04 KB
description create connection between components to share internal states

use-channel

Now, Atomico includes a context API as part of its core. We recommend implementing it as an alternative to using useChannel.

{% content-ref url="../../api/hooks/usecontext/" %} usecontext {% endcontent-ref %}


An alternative to React's context but solely based on hooks.

Modulo

import { useChannel } from "@atomico/hooks/use-channel";

Syntax

const channel = "MyChannel";
const [parentValue, setChildValue] = useChannel(channel);

Where :

  1. channel: String, defines the name of the event to be used to generate the channel.
  2. parentValue: Value inherited by the parent component.
  3. setChildValue: Callback, defines a value for nested components.

Example

{% embed url="https://webcomponents.dev/edit/collection/n2tZyzx4LMKqk1jNE0e9/34DlYUfeqmk0sO3BUa31/src/index.jsx" %}

This hook is used by @atomico/components/router