isdirtyvanilla v1.0.0

About The Project

Built With

• form-serialize: to serialize form state.
• Webpack
• Babel
• Jest

Getting Started

To get a local copy up and running follow these simple steps.

1. Clone the repo

   git clone https://github.com/kalizi/isDirtyVanilla.git

2. Install packages

   yarn

3. Edit files
4. Run tests

   yarn test

5. Build the project

   yarn start

API

init(targets = [])

init method receives an array or a single target containing inputs whose states needs to be tracked.

Throws:

• Error("No targets supplied"): if empty array given.
• Error("Invalid query selector supplied"): if wrong selectors passed in.

isDirty(form)

isDirty method returns true if the state of the form passed in changed, false otherwise.

Throws:

• Error("Invalid form supplied"): if parameter is not a valid element or is not tracked.

isDirtyBySelector(form, selector)

isDirtyBySelector method returns true if the state of the input for the form passed in changed, false otherwise.

Throws:

• Error("Invalid form supplied"): if first parameter is not a valid element or is not tracked.
• Error("Invalid selector supplied"): if second parameter is an empty string or null.
• Error("Selector gave no result."): if provided selector gives no result for the form passed in.

Roadmap

• Add API to get changed inputs

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.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

License

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

Contact

Kalizi - @kalizi_dev - me@kalizi.dev

Project Link: https://github.com/kalizi/isDirtyVanilla

Acknowledgments

• Best README Template