react-render-manager v1.0.2
React Render Manager โจ
Manage your JSX
render conditions in more cleaner and consistent way.
Features:
- ๐งผ Clean and consistent logic of rendering multiple render conditions
- ๐ Feels natural with server state management libraries such as react-query / SWR / apollo
- ๐ซ You can create your own reusable manager with default fallbacks
- ๐ช 100%
TypeScript
, types are generic (you can have your own states type) - โ 100% test coverage
Example with react-query:
import { useQuery } from 'react-query'
import RenderManager from 'react-render-manager'
const PostsPage = () => {
const { data, isError, isLoading } = useQuery('getPosts', getPosts)
const states = {
isError,
isLoading,
isEmpty: !data.length,
}
return (
<RenderManager states={states}>
{{
isError: <ErrorMessage />,
isLoading: <SkeletonLoader />,
isEmpty: <NoResults />,
default: <Posts posts={data} />,
}}
</RenderManager>
)
}
Install:
yarn:
yarn add react-render-manager
npm:
npm i react-render-manager
Important notes:
The order of the keys in the children is important and will determine which state will be rendered first if its true.
Make sure to provide only string keys, as other keys might change the ordering of the keys in the object.
Reusable manager component with default fallbacks
Note that the
fallbackChildren
props will always be rendered before the provided children (you can override them)
import RenderManager, { DefaultRenderManagerStates } from 'react-render-manager'
const CommonRenderManager = ({ states, children }) => {
return (
<RenderManager
states={states}
fallbackChildren={{
isError: 'Default error',
isLoading: 'Deault Loading...',
}}
>
{children}
</RenderManager>
)
}
Usage (You can omit isError
and isLoading
):
const states = {
isError: false,
isLoading: true,
}
return (
<CommonRenderManager states={states}>
{{
default: <h1>Rendered</h1>,
}}
</CommonRenderManager>
)
You can also override the fallbackChildren
:
const states = {
isError: false,
isLoading: true,
}
return (
<CommonRenderManager states={states}>
{{
isLoading: <h1>New Loading...</h1>,
default: <h1>Rendered</h1>,
}}
</CommonRenderManager>
)
Override the default state type:
The type of the rendered children is dynamically determened by the type of the
states
prop, by default it'sDefaultRenderManagerStates
type.
import RenderManager, { DefaultRenderManagerStates } from 'react-render-manager'
const App = () => {
const states: DefaultRenderManagerStates = {
isError,
isLoading,
}
return (
<RenderManager states={states}>
{{
isError: <h1>Error!</h1>,
isLoading: <h1>Loading...</h1>,
default: <h1>Default</h1>,
}}
</RenderManager>
)
}
Override the default type:
interface CustomRenderManagerStates {
loading: boolean;
error: boolean;
}
const App = () => {
const states: CustomRenderManagerStates = {
error,
loading,
}
return (
<RenderManager states={states}>
{{
error: <h1>Error!</h1>,
loading: <h1>Loading...</h1>,
default: <h1>Default</h1>,
}}
</RenderManager>
)
}
Other way:
const states = {
error,
loading,
}
return (
<RenderManager<CustomRenderManagerStates> states={states}>
{{
error: <h1>Error!</h1>,
loading: <h1>Loading...</h1>,
default: <h1>Default</h1>,
}}
</RenderManager>
)
You can also create reusable custom render manager:
Now you must provide
loading
&error
states (they are required in the interface)
import RenderManager, { RenderManagerProps } from 'react-render-manager'
interface CustomRenderManagerStates {
loading: boolean
error: boolean
}
export const CustomRenderManager = (
props: RenderManagerProps<CustomRenderManagerStates>
) => <RenderManager {...props} />
Props API
name | type | default | description | required | example |
---|---|---|---|---|---|
states | T , should be as - { [key: string]: boolean } | DefaultRenderManagerStates | the states of the render conditions | true | { isLoading: true, isError: false } |
children | RenderManagerChildren<T> , will extend keys of states props & default key | the render output (by the keys order) based on the states prop | true | { isLoading: <h1>Loading</h1>, default: <h1>Default</h1> } | |
fallbackChildren | Partial<RenderManagerChildrenBase<T>> Same as children but without default key | default fallback render output, if no children keys provided | false | { isLoading: <h1>Loading</h1> } |