@dotmind/rn-shadow-generator

React Native Shadow Generator to quickly generate shadow of your components. Builded by .mind.io

Menu

- Menu
- 🚀 Roadmap
- 🔍 Preview
- 💻 Installation
- 👷‍♂️ How it's work
- ShadowView usage
- generateShadow usage
- 🧪 Example app
- ⚡️ Contributing
- 🔐 License

🚀 Roadmap

* [ ] Android full compatibility (shadowOffset support)

🔍 Preview

!preview

💻 Installation

``bash
yarn add @dotmind/rn-shadow-generator
`

or

`bash
npm i @dotmind/rn-shadow-generator --save
`

👷‍♂️ How it's work

$3

`javascript
import { ShadowView } from '@dotmind/rn-shadow-generator';

const BasicComponent = () => {
return (

My Shadow View

);
}

const MyCustomComponent = () => {
return (

My Shadow View

);
}

`

| props | description | required | default value |
|-|-|-|-|
| level | Increase shadow dimensions | false | 4 |
| shadowColor | Change shadowColor style attribute | false | #000 |
| direction | Change shadow direction | false | bottom |

$3

Returns a full shadow object depending on OS (iOS or Android).

`javascript
import { generateShadow } from '@dotmind/rn-shadow-generator';

const BasicComponent = () => {
return (

My Shadow View

);
}

const MyCustomComponent = () => {
return (

My Shadow View

);
}

`

| attributes | description | required | default value |
|-|-|-|-|
| level | Increase shadow dimensions | false | 4 |
| shadowColor | Change shadowColor style attribute | false | #000 |
| direction | Change shadow direction | false | bottom |

Object returned

`javascript
{
...Platform.select({
ios: {
shadowColor,
shadowOffset,
shadowOpacity,
shadowRadius,
},
android: {
shadowColor,
elevation: level,
},
}),
}
`

🧪 Example app

To see full app integration example please refer to here.

> ⚠️ To run the app please run here yarn build` that the @dotmind/rn-shadow-generator npm package be able to link itselfs.

⚡️ Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

🔐 License

MIT