# guts_wrapper

> [![npm version](https://img.shields.io/npm/v/guts_wrapper.svg)](https://www.npmjs.com/package/guts_wrapper) [![License](https://img.shields.io/badge/license-Eldritch%20Mysteries-blue.svg)](https://github.com/Danil-Dorokhin/guts_wrapper/blob/master/LICENSE

Latest version **0.1.3** (published 2023-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install guts_wrapper
pnpm add guts_wrapper
yarn add guts_wrapper
bun add guts_wrapper
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2023-08-25 |
| First published | 2023-08-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Danil Dorokhin |
| Maintainers | danil_dorokhin |
| Keywords | react, components |

## Links

- npm: https://www.npmjs.com/package/guts_wrapper
- Repository: https://github.com/Danil-Dorokhin/guts_wrapper
- Homepage: https://github.com/Danil-Dorokhin/guts_wrapper.git#readme
- npm.io page: https://npm.io/package/guts_wrapper

## Dependencies (4)

- [react](https://npm.io/package/react.md) ^18.2.0
- [react-dom](https://npm.io/package/react-dom.md) ^18.2.0
- [react-redux](https://npm.io/package/react-redux.md) ^8.1.2
- [@reduxjs/toolkit](https://npm.io/package/@reduxjs/toolkit.md) ^1.9.5

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.3 (latest) — 2023-08-25
- 0.1.2 — 2023-08-20
- 0.1.1 — 2023-08-20
- 0.1.0 — 2023-08-20
- 0.0.12 — 2023-08-20
- 0.0.11 — 2023-08-20
- 0.0.10 — 2023-08-20
- 0.0.9 — 2023-08-20
- 0.0.8 — 2023-08-20
- 0.0.7 — 2023-08-20
- 0.0.6 — 2023-08-20
- 0.0.5 — 2023-08-20
- 0.0.4 — 2023-08-20
- 0.0.3 — 2023-08-19
- 0.0.2 — 2023-08-19
- … 1 more at https://npm.io/package/guts_wrapper/versions

## README

# Guts Wrapper

[![npm version](https://img.shields.io/npm/v/guts_wrapper.svg)](https://www.npmjs.com/package/guts_wrapper)
[![License](https://img.shields.io/badge/license-Eldritch%20Mysteries-blue.svg)](https://github.com/Danil-Dorokhin/guts_wrapper/blob/master/LICENSE)

## 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:

```bash
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:

```javascript
// 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:

```javascript
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 |<div/> | 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:
```bash
git clone https://github.com/Danil-Dorokhin/guts_wrapper.git
cd guts_wrapper
```
II. Conjure the artifacts:
```bash
yarn
```
III. Manipulate the cosmic forces and witness the metamorphosis:
```bash
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.

---
_Source: https://npm.io/package/guts_wrapper · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._