Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/camwest/react-slot-fill
Slot & Fill component for merging React subtrees together. Portal on steroids.
https://github.com/camwest/react-slot-fill
extensibility framework javascript react
Last synced: 3 months ago
JSON representation
Slot & Fill component for merging React subtrees together. Portal on steroids.
- Host: GitHub
- URL: https://github.com/camwest/react-slot-fill
- Owner: camwest
- License: other
- Created: 2017-03-07T20:01:46.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-12-01T19:03:25.000Z (almost 3 years ago)
- Last Synced: 2024-07-08T00:05:53.009Z (4 months ago)
- Topics: extensibility, framework, javascript, react
- Language: TypeScript
- Homepage: https://camwest.github.io/react-slot-fill/
- Size: 3.16 MB
- Stars: 655
- Watchers: 16
- Forks: 27
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# react-slot-fill · [](https://circleci.com/gh/camwest/react-slot-fill) [](https://www.codacy.com/app/cameron_4/react-slot-fill?utm_source=github.com&utm_medium=referral&utm_content=camwest/react-slot-fill&utm_campaign=Badge_Coverage) [](CONTRIBUTING.md)
Slot & Fill component for merging React subtrees together.
## Check out the [simple demo on glitch](https://rsf-demo.glitch.me/) ([view source](https://glitch.com/edit/#!/project/rsf-demo))
## Installation
```
npm install react-slot-fill --save
```
### Check out the examples locally
```
git clone https://github.com/camwest/react-slot-fill
cd react-slot-fill
npm start
```
## Usage
**Note** These examples use React Fiber Alpha
### Toolbar.js
```jsx
import { Slot, Fill } from 'react-slot-fill';
const Toolbar = (props) =>
export default Toolbar;
Toolbar.Item = (props) =>
{ props.label }
```
### Feature.js
```jsx
import Toolbar from './Toolbar';
const Feature = () =>
[
];
```
### App.js
```jsx
import Toolbar from './Toolbar';
import Feature from './Feature';
import { Provider } from 'react-slot-fill';
const App = () =>
ReactDOMFiber.render(
,
document.getElementById('root')
);
```
## Components
###
Creates a Slot/Fill context. All Slot/Fill components must be descendants of Provider. You may only pass a single descendant to `Provider`.
```typescript
interface Provider {
/**
* Returns instances of Fill react components
*/
getFillsByName(name: string): Fill[];
/**
* Return React elements that were inside Fills
*/
getChildrenByName(name: string): React.ReactChild[];
}
```
`getFillsByName` and `getChildrenByName` are really useful for testing Fill components.
See [src/lib/__tests/Provider.test.tsx](src/lib/__tests/Provider.test.tsx) for an example.
###
Expose a global extension point
```javascript
import { Slot } from 'react-slot-fill';
```
#### Props
```typescript
interface Props {
/**
* The name of the component. Use a symbol if you want to be 100% sue the Slot
* will only be filled by a component you create
*/
name: string | Symbol;
/**
* Props to be applied to the child Element of every fill which has the same name.
*
* If the value is a function, it must have the following signature:
* (target: Fill, fills: Fill[]) => void;
*
* This allows you to access props on the fill which invoked the function
* by using target.props.something()
*/
fillChildProps?: {[key: string]: any}
/**
* A an optional function which gets all of the current fills for this slot
* Allows sorting, or filtering before rendering. An example use-case could
* be to only show a limited amount of fills.
*
* By default Slot injects an unstyled `
` element. If you want greater
* control over presentation use this function.
*
* @example
*
* {(items) => {items}}
*
*/
children?: (fills) => JSX.Element
}
```
###
Render children into a Slot
```javascript
import { Fill } from 'react-slot-fill';
```
#### Props
```typescript
interface Props {
/**
* The name of the slot that this fill should be related to.
*/
name: string | Symbol
/**
* one or more JSX.Elements which will be rendered
*/
children: JSX.Element | JSX.Element[]
}
```
You can add additional props to the Fill which can be accessed in the parent node of the slot via fillChildProps.