{"_id":"@adriexnet/ual-reactjs-renderer","_rev":"1-c136177e42d44b717191f8cb5cadb643","name":"@adriexnet/ual-reactjs-renderer","dist-tags":{"latest":"0.3.1"},"versions":{"0.3.1":{"name":"@adriexnet/ual-reactjs-renderer","version":"0.3.1","main":"dist/index.js","author":{"name":"block.one","url":"https://block.one/"},"collaborators":["Nasser Abouelazm","Mike Manfredi"],"license":"MIT","scripts":{"build":"rm -rf dist && babel src --out-dir dist --source-maps","lint":"eslint --ext .js,.jsx,.ts,.tsx src","test":"jest","prepare":"yarn build","docs":"jsdoc src -r -d docs"},"dependencies":{"@react-icons/all-files":"^4.1.0","i18next":"14.0.1","i18next-browser-languagedetector":"2.2.4","prop-types":"15.7.2","react":"16.13.0","react-dom":"16.13.0","react-icons":"4.1.0","react-tooltip":"3.9.2","styled-components":"4.4.1","universal-authenticator-library":"0.3.0"},"devDependencies":{"@babel/cli":"^7.8.4","@babel/core":"^7.8.7","@babel/plugin-proposal-class-properties":"^7.8.3","@babel/plugin-transform-regenerator":"^7.8.7","@babel/preset-env":"^7.8.7","@babel/preset-react":"^7.8.3","@blockone/eslint-config-blockone":"^3.0.0","@types/i18next":"^12.1.0","@types/i18next-browser-languagedetector":"^2.0.1","@types/jest":"^25.1.4","@types/react":"15.0.4","babel-jest":"^25.1.0","babel-plugin-react-icons":"^0.1.1","babel-polyfill":"^6.26.0","enzyme":"^3.11.0","enzyme-adapter-react-16":"^1.15.2","enzyme-to-json":"^3.4.4","eslint":"^6.8.0","jest":"^25.1.0","jest-enzyme":"^7.1.2","jsdoc":"^3.5.5","typescript":"^3.8.3"},"description":"This library provides a React renderer around the [Universal Authenticator Library](https://github.com/EOSIO/universal-authenticator-library).","directories":{"example":"examples"},"repository":{"type":"git","url":"git+https://github.com/adriexnet/ual-reactjs-renderer.git"},"bugs":{"url":"https://github.com/adriexnet/ual-reactjs-renderer/issues"},"homepage":"https://github.com/adriexnet/ual-reactjs-renderer#readme","gitHead":"4736fa88d28e902f9508be2ae167ccb1ac1a4191","_id":"@adriexnet/ual-reactjs-renderer@0.3.1","_nodeVersion":"12.18.4","_npmVersion":"6.14.6","dist":{"integrity":"sha512-vSthw0IF82cFxq0+yPq/CjC3VA+em5PM8uAZqf6g3kac1W+l4bT8bNDPp1e3yXeBdjSo6y4nEQz6rW5EHzdBzA==","shasum":"a9e37783b3f088fa87b1db264fdb5646831c9372","tarball":"https://registry.npmjs.org/@adriexnet/ual-reactjs-renderer/-/ual-reactjs-renderer-0.3.1.tgz","fileCount":81,"unpackedSize":270874,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfyeoDCRA9TVsSAnZWagAArnEP/jj4ye9v40m7YMQTRkFw\nDAfzywzO9mtVBVCPiafs9yWypgJ3aQZLOoBrJQyqiRyMpoRfCVzLqsaMoJHV\nBfL8TF+oMH+76dYuC7BHcEb/Z9M6ZOJmWq3/0j3Yhfc+jVqLttaaNHu3OPNf\nlHor8diKH+hpfwHo7QLSnvNuWz8XmNERb5Oz11MIXFkOslEvNYzmcfL5KwNR\nPzGT5Vbl5JiysiUE1WzVDpKS/KGEUZ4kzes6kNa2LbbO+iWlAgd7AFh5xtRR\ncOQ5BLhkOffNhrkE+X/PdBgDJmilLv/jWRvkmC1GKYFjphJhb0c8MUqLk4F1\nc4jSNVYFa8glod7eKR9adAfcAL0x8nBozOmm/KKl0lxNT3PQLfvVOoQLWTDU\nX1XW8DjHCdoPYMJ2Juh1jDG7CtWeNWIJ7JrzLuuHgR8eBeSGErO8FIakHadd\nOw7Gg8NOSUj39HxkqwjdeZ9BMueIsdT9HR7q4QK3/4t6/3TgECXBeicMHo23\n6NMmKq8WszuEKNJP9qsCnmIsV4jpggdpkfptjdRmN6NiQSvSrJVjqSxjZZLq\nLm7Bifk1boKh1qqALL9SotK1Dt+fJUI4OpYNrwI4ja+P7kgMUx2Sns4+nI+n\n1sSxMJQavqifzr4ovRe9S8dL3H5+UKj5dsg0j4OZGapDVnU4V6t5BkQxrJrh\n+rLK\r\n=REHI\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICaaHINb6edsBH9pEH55AC23U3H0yUXdG9WhABvwj6CxAiB5btTMaRid0a+HVMwESRbeq/jN2Nj6/ZNCCDBEtx8BGg=="}]},"_npmUser":{"name":"adriexnet","email":"adriexnet@gmail.com"},"maintainers":[{"name":"adriexnet","email":"adriexnet@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ual-reactjs-renderer_0.3.1_1607068162778_0.5344303681008857"},"_hasShrinkwrap":false}},"time":{"created":"2020-12-04T07:49:22.725Z","0.3.1":"2020-12-04T07:49:22.948Z","modified":"2022-04-04T11:37:36.646Z"},"maintainers":[{"name":"adriexnet","email":"adriexnet@gmail.com"}],"description":"This library provides a React renderer around the [Universal Authenticator Library](https://github.com/EOSIO/universal-authenticator-library).","homepage":"https://github.com/adriexnet/ual-reactjs-renderer#readme","repository":{"type":"git","url":"git+https://github.com/adriexnet/ual-reactjs-renderer.git"},"author":{"name":"block.one","url":"https://block.one/"},"bugs":{"url":"https://github.com/adriexnet/ual-reactjs-renderer/issues"},"license":"MIT","readme":"# UAL Renderer for ReactJS\n\nThis library provides a React renderer around the [Universal Authenticator Library](https://github.com/EOSIO/universal-authenticator-library).\n\n![EOSIO Labs](https://img.shields.io/badge/EOSIO-Labs-5cb3ff.svg)\n\n# About EOSIO Labs\n\nEOSIO Labs repositories are experimental.  Developers in the community are encouraged to use EOSIO Labs repositories as the basis for code and concepts to incorporate into their applications. Community members are also welcome to contribute and further develop these repositories. Since these repositories are not supported by Block.one, we may not provide responses to issue reports, pull requests, updates to functionality, or other requests from the community, and we encourage the community to take responsibility for these.\n\n## Getting Started\n#### With ``yarn``\n```bash\nyarn add ual-reactjs-renderer\n```\nThen, install the authenticators that you wish to use...\n```bash\nyarn add ual-scatter ual-lynx\n```\n#### With ``npm``\n```bash\nnpm i ual-reactjs-renderer\n```\nThen, install the authenticators that you wish to use...\n```bash\nnpm i ual-scatter ual-lynx\n```\n\n## Basic Usage\n```javascript\nimport React from 'react'\nimport ReactDOM from 'react-dom'\nimport { UALProvider, withUAL } from 'ual-reactjs-renderer'\nimport { Scatter } from 'ual-scatter'\nimport { Lynx } from 'ual-lynx'\n\nimport { MyApp } from './MyApp'\n\nconst myChain = {\n  chainId: MY_CHAIN_ID,\n  rpcEndpoints: [{\n    protocol: MY_CHAIN_PROTOCOL,\n    host: MY_CHAIN_HOST,\n    port: MY_CHAIN_PORT,\n  }]\n}\n\nconst scatter = new Scatter([myChain], { appName: 'My App' })\nconst lynx = new Lynx([myChain], { appName: 'My App' })\n\nconst MyUALConsumer = withUAL(MyApp)\n\nReactDOM.render(\n  <UALProvider chains={[myChain]} authenticators={[scatter, lynx]} appName={'My App'}>\n    <MyUALConsumer />\n  </UALProvider>,\n  document.getElementById('ual-app')\n)\n```\n\n## Examples\nA small example is provided in the [examples](https://github.com/EOSIO/ual-reactjs-renderer/tree/develop/examples) folder.\n\n## Environment Set Up\n**A one-time environment setup is required prior to development.**  The following commands provides a quick starting point.  Make sure you are in the ``examples/`` directory.\n```bash\ncd examples\ncp default.env .env\n```\nNow that you have an ``.env`` file, you can set environment variables for your chain particulars.  Note that this file will not be version-controlled, nor should it be.\nThe default settings for the file are...\n```\nCHAIN_ID=cf057bbfb72640471fd910bcb67639c22df9f92470936cddc1ade0e2f2e7dc4f\nRPC_PROTOCOL=http\nRPC_HOST=localhost\nRPC_PORT=8888\n```\nThese values are taken from the local chain created by following the [Developer Portal node set up instructions](https://developers.eos.io/eosio-home/docs/getting-the-software). _(Note: if this is your first time following the tutorial you will need to install the eosio binaries [here](https://developers.eos.io/eosio-home/docs/setting-up-your-environment))_  These can be edited according to the requirements of your project if you have a different chain set up.  They will be used as the chain data in the example app.\n*See the [Basic Example App for UAL with ReactJS](https://github.com/EOSIO/ual-reactjs-renderer/tree/develop/examples) for more details.*\n\n## Development\nAfter you set up your environment you can begin development.  Make sure you are back in the ``/`` directory of the ``ual-reactjs-renderer`` package.\n```bash\nyarn\nyarn link\nyarn build -w\n```\n\nIn a duplicate terminal tab, enter the following commands:\n```bash\ncd examples\nyarn link ual-reactjs-renderer\nyarn\nyarn example\n```\n\nOpen a browser at `localhost:3000` to see a running instance of the example.\n\n*It is recommended to have at least two terminal tabs running so that `yarn build -w` and `yarn example` can run simultaneously creating an environment where changes are immediately reflected in the browser.*\n\n## Contributing\n\n[Contributing Guide](./CONTRIBUTING.md)\n\n[Code of Conduct](./CONTRIBUTING.md#conduct)\n\n## License\n\n[MIT](./LICENSE)\n\n## Important\n\nSee [LICENSE](./LICENSE) for copyright and license terms.\n\nAll repositories and other materials are provided subject to the terms of this [IMPORTANT](./IMPORTANT.md) notice and you must familiarize yourself with its terms.  The notice contains important information, limitations and restrictions relating to our software, publications, trademarks, third-party resources, and forward-looking statements.  By accessing any of our repositories and other materials, you accept and agree to the terms of the notice.\n","readmeFilename":"README.md"}