@gwdevs/permalinks-hooks

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

Permalinks React Hooks Library

Open paths through the forests of forms of your app.


Explore the docs and code playground »




View Demo
·
Report Bug
·
Request Feature

About The Project

[![Product Name Screen Shot][product-screenshot]](https://permalinks-hooks.netlify.app/)

Purpose:
A collection of React Hooks that provide a way to simplify the implementation of permalinks into your React projects.

Problem:
Many React app require the user to fill multistep forms with info that could be provided directly in the url.

Scope:
This project aims to simplify the implementing of permalinks into our projects and especially the common use cases.

Architecture and Design Principles:
See ARCHITECTURE.md for details on architecture and design principles for this project.

(back to top)

$3

* React.js
* React Stylguidist

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

$3

Data

This is an example of how to list things you need to use the software and how to install them.
* npm
``sh
npm install npm@latest -g
`

$3

1. Setup a React app using Create React App or React Styleguidist.
`sh
npx create-react-app my-app
`
2. Add it to your React app or component library (inside your project path):
* yarn
`sh
yarn add @gwdevs/permalinks-hooks
`
* npm
`sh
npm i @gwdevs/permalinks-hooks
`

(back to top)

Usage/Integration

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For more examples, please refer to the Styleguidist._

(back to top)

Roadmap

- [ ] Return data fetched using url params
- [ ] Change path dynamically depending on app state

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. Guidelines for external contributions.

You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

If you would like to fork the repo and create a pull request.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE` for more information.

(back to top)

Contact

Abel Perez - abelperez@idiomaspuentes.org

Project Link: https://github.com/gatewaycomponents/permalinks-hooks

(back to top)

Acknowledgments

* Abel Perez
* klappy

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/gatewaycomponents/permalinks-hooks.svg?style=flat
[contributors-url]: https://github.com/gatewaycomponents/permalinks-hooks/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gatewaycomponents/permalinks-hooks.svg?style=flat
[forks-url]: https://github.com/gatewaycomponents/permalinks-hooks/network/members
[stars-shield]: https://img.shields.io/github/stars/gatewaycomponents/permalinks-hooks.svg?style=flat
[stars-url]: https://github.com/gatewaycomponents/permalinks-hooks/stargazers
[issues-shield]: https://img.shields.io/github/issues/gatewaycomponents/permalinks-hooks.svg?style=flat
[issues-url]: https://github.com/gatewaycomponents/permalinks-hooks/issues
[license-shield]: https://img.shields.io/github/license/gatewaycomponents/permalinks-hooks.svg?style=flat
[license-url]: https://github.com/gatewaycomponents/permalinks-hooks/blob/master/LICENSE
[product-screenshot]: https://github.com/gatewaycomponents/permalinks-hooks/raw/master/public/screen-shot.png