# the-done

> Done page of the-components

Latest version **4.0.1** (published 2019-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install the-done
pnpm add the-done
yarn add the-done
bun add the-done
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.1 |
| Published | 2019-05-05 |
| First published | 2017-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 7 |
| Unpacked size | 52.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | react-component, the |

## Links

- npm: https://www.npmjs.com/package/the-done
- Repository: https://github.com/the-labo/the-done
- Homepage: https://github.com/the-labo/the-done#readme
- Issues: https://github.com/the-labo/the-done/issues
- npm.io page: https://npm.io/package/the-done

## Dependencies (7)

- [classnames](https://npm.io/package/classnames.md) ^2.2.6
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.2
- [@the-/ui-link](https://npm.io/package/@the-/ui-link.md) ^15.4.0
- [@the-/util-ui](https://npm.io/package/@the-/util-ui.md) ^15.4.1
- [@the-/const-ui](https://npm.io/package/@the-/const-ui.md) ^15.4.2
- [@the-/ui-style](https://npm.io/package/@the-/ui-style.md) ^15.4.0
- [@the-/ui-button](https://npm.io/package/@the-/ui-button.md) ^15.4.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 4.0.1 (latest) — 2019-05-05
- 4.0.0 — 2019-05-05
- 3.0.14 — 2019-02-07
- 3.0.12 — 2018-11-16
- 3.0.11 — 2018-11-14
- 3.0.10 — 2018-09-28
- 3.0.9 — 2018-08-12
- 3.0.8 — 2018-07-06
- 3.0.7 — 2018-06-18
- 3.0.6 — 2018-06-18
- 3.0.5 — 2018-06-18
- 3.0.4 — 2018-06-17
- 3.0.3 — 2018-06-16
- 3.0.2 — 2018-06-09
- 3.0.1 — 2018-03-02
- … 6 more at https://npm.io/package/the-done/versions

## README

the-done
==========

<!---
This file is generated by the-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-done
[bd_travis_url]: http://travis-ci.org/the-labo/the-done
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-done.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-done
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-done.svg?token=
[bd_license_url]: https://github.com/the-labo/the-done/blob/master/LICENSE
[bd_npm_url]: http://www.npmjs.org/package/the-done
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-done.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Done page of the-components

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-done --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

[Live Demo](https://the-labo.github.io/the-done/doc/demo/index.html#/) is hosted on GitHub Page

```javascript
'use strict'

import React from 'react'
import { TheLinkStyle } from 'the-link'
import { TheButtonStyle } from 'the-button'
import { TheRouter } from 'the-router'
import { TheDone, TheDoneStyle } from 'the-done'

class ExampleComponent extends React.PureComponent {
  render () {
    return (
      <TheRouter.Hash>
        <TheLinkStyle/>
        <TheButtonStyle/>
        <TheDoneStyle/>
        <TheDone message="You are done!"
                 actionText="Return to Top"
                 onAction={() => window.location.reload()}
                 subActionText="Do something else"
                 onSubAction={() => window.location.reload()}
                 linkText={'Some Link'}
                 linkTo={String(new Date().getTime())}
                 onLinkClick={() => console.log('link clicked')}
        >
        </TheDone>
      </TheRouter.Hash>

    )
  }
}

export default ExampleComponent

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Components.md.hbs" Start -->

<a name="section-doc-guides-03-components-md"></a>

Components
-----------

### TheDone

Done page of the-components

**Props**

| Name | Type | Description | Default |
| --- | --- | ---- | ---- |
| `actionText` | string  | Action button text | `null` |
| `linkText` | string  | Text of link | `null` |
| `linkTo` | string  | Link url | `null` |
| `message` | string  |  | `null` |
| `onAction` | func  | Handler for action | `null` |
| `onLinkClick` | func  | Handle link click | `null` |
| `onSubAction` | func  | Handler for sub action | `null` |
| `subActionText` | string  | Sub action button text | `null` |

### TheDoneStyle

Style for TheDone

**Props**

| Name | Type | Description | Default |
| --- | --- | ---- | ---- |
| `options` | object  | Style options | `{}` |



<!-- Section from "doc/guides/03.Components.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-done/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][the_labo_url]

[the_labo_url]: https://github.com/the-labo

<!-- Links End -->

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