{"_id":"@atom-iq/ref","_rev":"1-271c7edbffccda84a010f470567ff011","name":"@atom-iq/ref","dist-tags":{"latest":"0.2.0-alpha"},"versions":{"0.2.0-alpha":{"name":"@atom-iq/ref","version":"0.2.0-alpha","description":"Atom-iQ Ref Middleware","author":{"name":"Adam Filipek","email":"adamfilipek1@gmail.com","url":"https://github.com/adamf92"},"license":"MIT","main":"dist/index.umd.min.js","module":"dist/index.es.min.js","types":"dist/lib/types/src/index.d.ts","peerDependencies":{"@atom-iq/core":"0.2.0-alpha","rxjs":"^7.0.0-beta.8"},"devDependencies":{"@atom-iq/core":"^0.2.0-alpha","rxjs":"^7.0.0-beta.8"},"licenseText":"# MIT License\nCopyright (c) 2020 Adam Filipek\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","_id":"@atom-iq/ref@0.2.0-alpha","dist":{"shasum":"d654644ee50df572b5b4cc97cbf231c8d5ded45a","integrity":"sha512-+hNGoZnoRm4/nKJwdPO/tNU5nIOOy6XncpdEiacs9FVCSUbHKvLLyK6UHw0y7E+TDeZ0E7o937OWejJGQQSmgw==","tarball":"https://registry.npmjs.org/@atom-iq/ref/-/ref-0.2.0-alpha.tgz","fileCount":48,"unpackedSize":29691,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfkE+GCRA9TVsSAnZWagAAVG0QAJFc2BCwhLvllhuyElJI\nA+E1zMHs6qoCh6La2/8W8r6toUJyGUvZDKHmtBHoqPwFsTfPlIz3oanGyep1\nXLCOrt6pUXCSbSSRHWICgKgdQiKLhIhlaSEiDlR0yF6T33tR9FKStS/7OFVc\nvL5ep8pzi6JeE/Qn1rQFmG2WO0Gbu0HnQahGoCvecSLTxkOsmRuwg5qj3b+d\nw6KK5msjvQyI9ElmINnbmd1YAk+0zDDoER8xcqUq7mBHAXJ4tLmMijFhXfX5\ninyV8Jp86eFERnWf5jOnN4T2Fe6ET49m3h8dIQ+v4tH6tXrT7oYC4gYmRT2k\nJ3GDAHVIQh1S/RGZWGMAafRPM0Qfo5HPb2gc/bIyaU8tslIIrRTMpb1Ej0it\n5slNdhFVEacULXqHtrApMHbLDKv5BuLkHp9WdQHR3tc7ya5TB1GRQzsl6KSq\n/RzRw+fsmK4WhOB5E5xipHFTLztNf8TIuXBUGLdOYi0AjV2YRKsaCZW//R6q\nuf01irTx2CQ0Pf9ykzEMQUzyqxTfm3VYjxnuT2ePw5nbPKD9uK0jWLCfHouw\nsCEeXGRRYqbca5Lr7w7x5mytpnzqq8bJOarYnDxKHD1FLIuN4c+B5+7cgXVh\nojM3drDMjlHJHgnIIedvhmREV3fUdRywzMXNOOs9HqmsuHyKo+Kht13dCZkx\nzQ6s\r\n=/r/J\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHl+j5dLzqejpM9rgapLv0zwAyF2DawOBwFqqMvOO+JKAiAKWS79XN52jCIiGrTbohc1SZhcvZLTQeA8WZHbHhB30w=="}]},"maintainers":[{"name":"adamf","email":"adamfilipek1@gmail.com"}],"_npmUser":{"name":"adamf","email":"adamfilipek1@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ref_0.2.0-alpha_1603293061867_0.6454416176153741"},"_hasShrinkwrap":false}},"time":{"created":"2020-10-21T15:11:01.592Z","0.2.0-alpha":"2020-10-21T15:11:02.002Z","modified":"2022-04-04T16:14:14.207Z"},"maintainers":[{"name":"adamf","email":"adamfilipek1@gmail.com"}],"description":"Atom-iQ Ref Middleware","author":{"name":"Adam Filipek","email":"adamfilipek1@gmail.com","url":"https://github.com/adamf92"},"license":"MIT","readme":"# Atom-iQ Ref Middleware (`@atom-iq/ref`)\n#### Installing\n- npm - `npm install --save @atom-iq/ref`\n- yarn - `yarn add @atom-iq/ref`\n\n\n#### Ref\nMiddleware allowing using Element and Component Refs\n\n#### Starting the app\n```typescript jsx\nimport App from './App'\nimport { createRvDOM, combineMiddlewares } from '@atom-iq/core'\nimport { refMiddleware } from '@atom-iq/ref'\n\nconst middlewares = combineMiddlewares(refMiddleware())()\n\nconst rvDOMSubscription = createRvDOM(middlewares)(, document.getElementById('root'))\n```\n\n#### Usage\n```typescript jsx\nimport { RvdComponent, createState } from '@atom-iq/core'\nimport { elementRef, componentRef, WithAttachRef } from '@atom-iq/ref'\nimport { first } from 'rxjs/operators'\n\nconst RefComponent: RvdComponent<{}, WithAttachRef> = (_props, { attachRef }) => {\n const [testState, nextTestState] = createState('test')\n \n const handleTestStateChange = (value: string) => nextTestState(value)\n \n attachRef(ref => ({\n ...ref,\n state: {\n testState\n },\n functions: {\n handleTestStateChange\n }\n }))\n\n return (\n
\n Component with attached ref\n
\n )\n}\n\nconst App: RvdComponent = () => {\n const [element, connectElement] = elementRef(['className', 'id'], ['click'])\n const [component, connectComponent] = componentRef()\n\n first()(element).subscribe(ref => {\n const [buttonId, nextButtonId] = ref.props.id\n ref.events.click.subscribe(event => { // Use Teardown Middleware for auto-unsubscribe\n // Do something\n })\n console.log(ref.domElement) // button\n })\n \n first()(component).subscribe(ref => {\n ref.state.testState.subscribe(value => { // Use Teardown Middleware for auto-unsubscribe\n // do something\n })\n ref.functions.handleTestStateChange('New test state')\n })\n \n return (\n
\n \n
\n )\n}\n\n```\n\n## Documentation\n- [Framework](../../README.md)\n- [Reactive Virtual DOM](../../docs/reactive-virtual-dom/REACTIVE-VIRTUAL-DOM.md)\n- [Component](../../docs/framework/COMPONENT.md)\n- [Elements](../../docs/framework/ELEMENTS.md)\n- [Middleware](../../docs/framework/MIDDLEWARE.md)\n\n","readmeFilename":"README.md"}