# dwcarousel

> A carrosel container component.

Latest version **0.0.1** (published 2019-04-12) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-04-12 |
| First published | 2019-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 425 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Cleber Jr - dwcleb |
| Maintainers | dwcleb |
| Keywords | carousel, react-native, react |

## Links

- npm: https://www.npmjs.com/package/dwcarousel
- Repository: https://github.com/DwCleb/DWcarousel
- Homepage: https://github.com/DwCleb/DWcarousel#readme
- Issues: https://github.com/DwCleb/DWcarousel/issues
- npm.io page: https://npm.io/package/dwcarousel

## Dependencies (3)

- [react](https://npm.io/package/react.md) 16.0.0
- [react-native](https://npm.io/package/react-native.md) 0.51.0
- [react-native-carousel](https://npm.io/package/react-native-carousel.md) ^0.11.0

## 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.0.1 (latest) — 2019-04-12

## README

## <a name="section-dwcarousel"> DWcarousel 
### Description

A carrosel container component.

### Props

| Name     | Type   | Required | Default value | Description                                                                                                                  |
| -------- | ------ | -------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| DWcarousel.Page      | `React.Node`  | `true`  | -         | A component that will be rendered the pages `DWcarousel`|
| children              | `React.Node`  | `false` | `null`    | A component that will be rendered inside the `DWcarousel.Page`. |
| initialPage           | `Integer`     | `false` | 0         | Set a initial page |
| hideIndicators        | `Boolean`     | `false` | `false`   | Set to true to hide the indicators |
| indicatorColor        | `String`      | `false` | `#FFFFFF` | Active indicator color |
| indicatorSize         | `Float`       | `false` | 30        | Indicator bullet size |
| indicatorSpace        | `Float`       | `false` | 15        | Space between each indicator |
| inactiveIndicatorColor| `String`      | `false` | `#DDDDDD` | Inactive indicator color |
| indicatorAtBottom     | `Boolean`     | `false` | `true`    | Set to false to show the indicators at the top |
| indicatorOffset       | `Float`       | `false` | 0         | Indicator relative position from top or bottom |
| inactiveIndicatorText | `String`      | `false` | '•'       | Inactive indicator content ( You can customize to use any Unicode character ) |
| indicatorText         | `String`      | `false` | '•'       | Active indicator content ( You can customize to use any Unicode character ) |
| animate               | `Boolean`     | `false` | `false`   | Enable carousel autoplay |
| delay                 | `Integer`     | `false` | 1000      | Set Animation delay between slides |
| loop                  | `Boolean`     | `false` | `false`   | Allow infinite looped animation. Depends on Prop {...animate} set to true. |
| containerStyle        | `TStyle`      | `false` | {}        | Style container - component `BBCarrosel` |
| pageStyle             | `TStyle`      | `false` | {}        | Style container - component `DWcarousel.Page` |


### Usage example

```javascript
  ...

  render() {
    ...
    return (
      <DWcarousel
        indicatorColor="red"
      >
        <DWcarousel.Page>
          <View>
            <Text>Content 1 - Page 1</Text>
          </View>
          <View>
            <Text>Content 2 - Page 1</Text>
          </View>
        </DWcarousel.Page>
        <DWcarousel.Page>
          <View>
            <Text>Content 1 - Page 2</Text>
          </View>
          <View>
            <Text>Content 2 - Page 2</Text>
          </View>
        </DWcarousel.Page>
      </DWcarousel>
    )
  ...
```

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