@transform-data/transform-react

React components and hooks for querying Transform's MQL Server

Table of Contents

• Documentation
• Installation
• Getting Started
• Contributing
• Support + Feedback
• Vulnerability Reporting
• License

Documentation

More details coming soon. Please bear with us!

Installation

Using npm

npm install @transform/transform-react

Using yarn

yarn add @transform/transform-react

Getting Started

More details coming soon. Please bear with us!

Contributing

Warning! yarn link is tricky with React Hooks. Here is how you can achieve greatness!

It involves links in two different directions, so please read the following carefully:

cd YOUR_PROJECT
cd node_modules/react
yarn link
cd ../react-dom
yarn link

cd transform-react/
yarn install
yarn link react
yarn link react-dom
yarn link

cd YOUR_PROJECT
yarn link @transform-data/transform-react

It is generally safe to leave transform-react linked to your project indefinitely. Therefore, to undo this linking, you need only unlink transform-react in your project:

cd YOUR_PROJECT
yarn unlink @transform-data/transform-react

Next, it critical to remember that your project is importing compiled code in the dist folder, so as you make updates to the library, be sure to have a process running:

yarn run tsc --watch

Support + Feedback

For support or to provide feedback, please raise an issue on our issue tracker.

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker. For the time being, please reach out to folks from Transform directly.

License

This project is licensed under the MIT license.