guts_wrapper v0.1.3
Guts Wrapper
Beyond the Veil of Loading
Hey hey people, the guts_wrapper
enigma unfurls before the audacious seeker, an arcane tool born from the eldritch depths of code, an artifact to contend with the inscrutable chaos that is Redux. This artifact provides the GutsWrapper
, a spectral entity to navigate the ebb and flow of loading states within the realms of React.
Installation Ritual
Invoke the power of guts_wrapper
using the incantation:
yarn add guts_wrapper
Unveil the Secrets
As mortal souls are drawn to the labyrinthine dance of reducers, one must beckon the gutsLoading
slice from the void and entwine it into the fabric of your Redux sanctum. Prepare for the eldritch revelation that shall unfold before your very eyes.
The Ritual of Reducers
In the hidden sigils of your reducers, an unholy amalgamation must transpire. From the cryptic depths of reducers.js
, heed this conjuration:
// reducers.js
import { combineReducers } from 'redux';
import { gutsLoading } from 'guts_wrapper';
// Align the constellations with the roots of your other reducers
const rootReducer = combineReducers({
// otherworldly reducers
gutsLoading,
});
// The cosmic sigil is complete
export default rootReducer;
Behold, the gutsLoading sigil is etched into your Redux tapestry, ready to interweave its mystical threads into the grand tapestry of your arcane state.
The Emanation of Example
Envelope your components in the tendrils of the GutsWrapper
, entwined with the ethereal action
prop:
import { GutsWrapper, LoadingFallback } from 'guts_wrapper';
// Invoke the GutsWrapper, a manifestation from the mists of 'guts_wrapper'
// Note that you can pass style to GutsWrapper directly and/or provide it with some container component that will be used as wrapper base
const YourComponent = () => {
return (
<GutsWrapper
action="reducerName/actionName"
style={{display:'flex'}}
container={<div style={{backgroundColor:'crimson'}} />}
>
{/* Peer into the abyss and place your esoteric content here */}
</GutsWrapper>
);
};
// Emit the incantation to the realms beyond, a beacon of the enigmatic YourComponent
export default YourComponent;
Enigmatic Glyphs: Prop
GutsWrapper
Glyph | Nature | Enigma | Revelation |
---|---|---|---|
action | string | --- | The action that beckons the shifting state. |
children | node | --- | The essence to enshroud and to unveil. |
style | CSSProperties | {} | Mystical styles to adorn the GutsWrapper. |
container | JSX.Element | The portal that embraces the arcane journey. |
The Arcane Path of Development
If thou art drawn to unravel the threads of destiny, heed these words:
I. Ensnare the repository:
git clone https://github.com/Danil-Dorokhin/guts_wrapper.git
cd guts_wrapper
II. Conjure the artifacts:
yarn
III. Manipulate the cosmic forces and witness the metamorphosis:
yarn dev
IV. If the constellations align, proffer a supplication in the form of a pull request.
Forbidden Knowledge
This creation emerges from the eldritch weave, bound by the enigmatic MIT License - peer into the LICENSE to decipher its inscrutable clauses.