@gwdevs/permalinks-hooks
v1.1.1-beta.1
Published
A collection of React Hooks that provide a way to simplify the implementation of permalinks into your React projects.
Downloads
9
Readme
About The Project
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.
Built With
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.
Prerequisites
Data
This is an example of how to list things you need to use the software and how to install them.
- npm
npm install npm@latest -g
Installation/First Steps
- Setup a React app using
Create React App
orReact Styleguidist
.
npx create-react-app my-app
- Add it to your React app or component library (inside your project path):
- yarn
yarn add @gwdevs/permalinks-hooks
- npm
npm i @gwdevs/permalinks-hooks
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.
Roadmap
See the open issues for a full list of proposed features (and known issues).
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.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Abel Perez - [email protected]
Project Link: https://github.com/gatewaycomponents/permalinks-hooks