{"dist":{"shasum":"2310f6fb7492cc278fec98e690d67adc6bfff9fc","tarball":"https://registry.npmjs.org/use-descendants/-/use-descendants-1.0.0-beta.3.tgz","fileCount":7,"integrity":"sha512-Td6aU0LfxhQM5ZKscrmZd0LUPd410K+fCvJLXO7cjCEkymFuiMBrmD+N0ZI0vga8vZvAMaQiP7F0qcxogzBoKQ==","signatures":[{"sig":"MEQCIG+lBAvEvZvMIV1cCWV7wFVRajgs49DlBgGlvIj88Oc4AiAp9P9aytJlvUuj9U2t++GDlLDiTGxyJMMCJbtiIwGw+Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5239,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg6S/wCRA9TVsSAnZWagAA1qUQAKPKHv05B5m7QHX1QZWe\nf7hARxcJhEMOO5u5obWtKmCEsLB4tBxHh064dO772KFc+hb5KhwZ+uIuBA/V\nd1WOSV64mCkH4KVvL5tnNXJgpMrcoiF9/w+is8bbRlGZ7+mWhMvDbXVU1blD\n9TXI0vjiua0g9LcB2NR/8O6NwAQsaJUeLtduwmRF4cP1+pyoow/Y4SJdG4Vi\nlGRCoeqYS6vUzXXMENZbTuRmu1RRvo2zRRy5YUF6V83EGGVMs0OO7a71YOt+\nbrocy0D8vACqomjmbMRB3tkIqvOQ+UmDY2CtvHzbjpb3L4nUpHD0BC8v/llR\nwviLZUVhsMvnVepzk2KHQj7ka8RYWM8S0Ci8OyOj2HFnrQubtNV8aI2FiNJy\nUHhZF10Le8ioJIXZHk0a7IUCvoUBJZiSEkITYrS63eIooZR9R/t2Tr+oeD1N\nBx8v+iiNQyTER3zjOd/ExxQ6Qo9vunmK+btk7DeuFHGfPjz0a/87002n/Cp9\nDTR85AyiDLseTrROO1+wD/KOeuuDQVQMBla2fJU+jFjRI/8a/GOVDB50/SMG\noeK+QJjUP+ixL72rFweWg8Gna1sMDlPglQqZr5aBLFM1CVUw8sMowLrd7FjV\nClruQK2SEbw1r/zzjx8tDKNhygEbWvEk6yyz3T/DpSck43tLorJIzaApwWtJ\nbdea\r\n=4SUK\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./dist/index.js","name":"use-descendants","module":"./dist/index.modern.js","readme":"# useDescendants ![npm bundle size](https://img.shields.io/bundlephobia/minzip/use-descendants)\n\nuseDescendants is a react hook for keeping track of descendant components and their relative indeces. It's based off the [@reach/descendants](https://www.npmjs.com/package/@reach/descendants) package, but faster and smaller.\n\nIf you want to understand more about what this package does or why we need it, read the [Problem Complex](https://www.npmjs.com/package/@reach/descendants) from the @reach/descendants package.\n\nIn short, this package allows each item in a list to know it's relative index and the parent of the list can keep track of each child, without needing to render in a loop and pass each component an index.\n\nThis enables component composition:\n\n```js\n<List>\n  <Item /> {/* I'm index 0 */}\n  <Item /> {/* I'm index 1 */}\n  <div>\n    <div>\n      <Item /> {/* I'm arbitrarily nested, but still know that I'm index 2 */}\n    </div>\n  </div>\n</List>\n```\n\n## Installation\n\n```\n$ yarn add use-descendants\n```\n\n## Usage\n\nIn the parent, you call `useDescendants` and pass the result to `<Descendants>` that wraps the children. In each child item, retrieve that items index with the `useDescendant` hook.\n\n```jsx\nconst Menu = () => {\n  const context = useDescendants()\n  return (\n    <Descendants value={context}>\n      <Item />\n    </Descendants>\n  )\n}\n\nconst Item = () => {\n  const index = useDescendant()\n  return <div>My index is {index}</div>\n}\n```\n\nYou can pass any data you want to `useDescendant` and it will be available in the parent through the `map` ref:\n\n```jsx\n// In Item\nconst ref = useRef()\nconst index = useDescendant({ ref })\n\n// In Menu\nconst context = useDescendants()\nconsole.log(context.map.current)\n// => { '<randomItemId>': { index: 0, props: { ref: HTMLDivElement } } }\n```\n\nYou can also pass un-memoized values or callbacks here because it's just kept in a ref:\n\n```jsx\nconst index = useDescendant({\n  onSelect: () => {\n    /* Do something */\n  }\n})\n```\n\n## Credits\n\n- [@reach/descendants](https://www.npmjs.com/package/@reach/descendants) and [Chance](https://twitter.com/chancethedev), who introduced me to this concept\n- @shuding for help with a faster, simpler implementation\n","source":"./index.js","license":"MIT","scripts":{"build":"microbundle --compress --no-sourcemap","prepublish":"yarn build"},"_npmUser":{"name":"paco","email":"pvco.coursey@gmail.com"},"description":"useDescendants is a react hook for keeping track of descendant components and their relative indeces. It's based off the [@reach/descendants](https://www.npmjs.com/package/@reach/descendants) package, but faster and smaller.","directories":{},"maintainers":[{"name":"paco","email":"pvco.coursey@gmail.com"}],"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"microbundle":"^0.13.3"},"peerDependencies":{"react":"*","react-dom":"*"},"_npmOperationalInternal":{"tmp":"tmp/use-descendants_1.0.0-beta.3_1625894896486_0.7656891309878446","host":"s3://npm-registry-packages"},"_id":"use-descendants@1.0.0-beta.3","version":"1.0.0-beta.3"}