Spend less time crafting your Compound Components structure
npm install react-compound-composer
Spend less time crafting your Compound Components structure
This library aims to make it easier to develop and maintain Compound Components by encapsulating context creation and compound composition logic under two core helpers.
Check those amazing posts to learn more about Compound Components:
- https://www.smashingmagazine.com/2021/08/compound-components-react/
- https://betterprogramming.pub/compound-component-design-pattern-in-react-34b50e32dea0
- https://blog.logrocket.com/understanding-react-compound-components/
1. Simple Counter Example: An almost in-line example of a Counter with its own state. Here just for a very quick proof-of-concept.
2. A Better Structured Example: An example of an Accordion compound
3. Nested Compounds Example: An example of nested compound
4. Flattened Root Example: An example of how you can flatten Root components
Start off by creating your context. This context will be available via a hook on all the sub-components. A good way to keep a dispatch-editable state across the components.
``tsx
import { contextBuilder } from "react-compound-composer";
const {
Consumer: CounterConsumer, // Consumer is also returned, just for convenience
Provider: CounterProvider,
useContext: useCounterContext,
} = contextBuilder(() => {
const [count, setCount] = useState(0);
return {
count,
increase: (count: number) => setCount((c) => c + count),
decrease: (count: number) => setCount((c) => c - count),
};
});
`
Create a few components to be composed under the compound.
`tsx
import React from "react";
const CounterRoot = (props: React.PropsWithChildren) => {
return (
`tsx
import React from "react";const CounterCount = () => {
const ctx = useCounterContext();
return {ctx.count};
};
``tsx
import React from "react";const CounterIncrease = () => {
const ctx = useCounterContext();
return ;
};
``tsx
import React from "react";const CounterDecrease = () => {
const ctx = useCounterContext();
return ;
};
`3. Compose your Compound with them!
Finally compose your Compound with the components you've created.
`tsx
import { compoundBuilder } from "react-compound-composer";export const Counter = compoundBuilder({
name: "Counter",
provider: CounterProvider,
components: {
Root: CounterRoot,
Count: CounterCount,
Increase: CounterIncrease,
Decrease: CounterDecrease,
},
});
`4. Enjoy your Compound!
Use your compound as desired.
`tsx
export default function App() {
return (
);
}
`How to Flatten
Root Components?If you prefer using the root components without actually using their
Root properties, you can set the flattenRoot option to true. Like so:`tsx
import { compoundBuilder } from "react-compound-composer";export const Counter = compoundBuilder({
name: "Counter",
provider: CounterProvider,
flattenRoot: true,
components: {
Root: CounterRoot,
Count: CounterCount,
Increase: CounterIncrease,
Decrease: CounterDecrease,
},
});
`and use the Compound like so:
`tsx
export default function App() {
return (
);
}
``© 2023 Taha Anılcan Metinyurt (iGoodie)
For any part of this work for which the license is applicable, this work is licensed under the Attribution-ShareAlike 4.0 International license. (See LICENSE).