# react-timelinev2

> Reusable react components to react a good looking and responsive timeline out the box!

Latest version **2.0.0** (published 2021-08-15) · MIT license · 0 weekly downloads

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

## Install

```sh
npm install react-timelinev2
pnpm add react-timelinev2
yarn add react-timelinev2
bun add react-timelinev2
```

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2021-08-15 |
| First published | 2020-08-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 2 |
| Unpacked size | 14.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Dev-CasperTheGhost |
| Maintainers | casper124578 |
| Keywords | frontend, front-end, responsive, react, timeline |

## Links

- npm: https://www.npmjs.com/package/react-timelinev2
- Repository: https://github.com/Dev-CasperTheGhost/react-timeline
- Homepage: https://github.com/Dev-CasperTheGhost/react-timeline#readme
- Issues: https://github.com/Dev-CasperTheGhost/react-timeline/issues
- npm.io page: https://npm.io/package/react-timelinev2

## Dependencies (2)

- [styled-components](https://npm.io/package/styled-components.md) ^5.3.0
- [@casper124578/eslint-config-react](https://npm.io/package/@casper124578/eslint-config-react.md) ^0.1.1

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

- 2.0.0 (latest) — 2021-08-15
- 1.5.0 — 2021-05-06
- 1.4.0 — 2021-04-30
- 1.3.3 — 2021-01-27
- 1.3.2 — 2020-10-24
- 1.3.1 — 2020-09-22
- 1.3.0 — 2020-09-21
- 1.2.1 — 2020-09-13
- 1.2.0 — 2020-09-10
- 1.1.0 — 2020-08-30
- 1.0.0 — 2020-08-30

## README

# React Timeline

Reusable react components to create a good looking and responsive timeline out the box!

## Table of contents

- [Installation](#installation)
- [Usage](#usage)
- [Available Props](#available-props)

## Installation

### npm

```bash
npm install react-timelinev2
```

### Yarn

```bash
yarn add react-timelinev2
```

## Usage

```js
import React from "react";
import { Timeline, TimelineItem } from "react-timelinev2";

function App() {
  return (
    <div className="App">
      <Timeline>
        <TimelineItem side="left" title="hello world" date="2020">
          Some text
        </TimelineItem>
        <TimelineItem shadows hoverShadow side="left" title="hello world" date="2020">
          I will have shadows!
        </TimelineItem>
        <TimelineItem side="right" title="hello world" date="2020">
          Some text
        </TimelineItem>
        <TimelineItem side="right" title="hello world" date="2020">
          Some text
        </TimelineItem>
      </Timeline>
    </div>
  );
}
```

## Screenshot

![screenshot](./react-timeline.png)

## Playground

<https://codesandbox.io/s/k2ix2>

## Available Props

### Timeline

| Option     | type   | description                             | required |
| ---------- | ------ | --------------------------------------- | -------- |
| timelineBg | string | Set a background color for the timeline | false    |

### TimelineItem

| Option        | type    | description                                  | required |
| ------------- | ------- | -------------------------------------------- | -------- |
| title         | string  | set the title                                | true     |
| side          | string  | `left` or `right`                            | true     |
| date          | string  | set a date                                   | true     |
| bgColor       | string  | set a background color for the timeline item | false    |
| bodyTextColor | string  | Set a color for the body text                | false    |
| dateColor     | string  | Set a color for date                         | false    |
| titleBg       | string  | Set a background color for the title         | false    |
| titleColor    | string  | Set a color for title                        | false    |
| borderRadius  | string  | Set a border radius for the timeline item    | false    |
| shadows       | boolean | Sets a box-shadow                            | false    |
| hoverShadow   | boolean | Sets a box-shadow on hover only              | false    |

## Supporting react-timelinev2

**All stars/forks are appreciated!**

Made with ❤ and TypeScript

## License

[MIT](./LICENSE)

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