{"dist":{"shasum":"e7db1a78b00aba929d2105211060cb8bb57bf3d0","tarball":"https://registry.npmjs.org/use-descendants/-/use-descendants-1.0.0-beta.5.tgz","fileCount":7,"integrity":"sha512-Byj+o8uFNQyBaOMSm/TQM0hMaJXMI9hlJDgL/CL1zwUTYxBIx0ajS8lFBwWbPMENnSkucF69pBJbYLfXzpyLGg==","signatures":[{"sig":"MEUCIQCSvnxP13MPHyd6G6Gof4YKDP+IxyFcXFYX2isM4MVvuQIgWKNrlu191rMF++5uxKwy41P2EoPKyxXj91q+mfqOC1Q=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5348,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJg7NAZCRA9TVsSAnZWagAAFvoP/RNP7KsooFOm77dxCQqF\nhLdLcAoEVjnFEahAzEOJx4MHGI9phNPm8F7F02ZL3sRU2WDch84pT8BtC1bi\ne0sRDx8L0hPdmmlUTVtvevO46jqfoqlo1EW/Gby3C62c0S5XFrPmnkXLv23A\nNVCddVoo4BX8YdZ8y72z1++CUV2/BDWOB4ASGIf6qP2yRu2Qz1iTdiGdepXf\nekBYtOcPjDOfoiYLA52Ka5HGFVNaIrxg7Xnpsb+rZMAje6lm4PEBxoDPKbp5\ni5/9Jxghty5YaWZzTS3ECHn1aaCUI3nM33rtyh51yJiSX0ml6I5xgb5TOYWP\nkPBkE8plWfQQ3hi7oHlTjLItduFK/uzFrImXgkgYAxoOKINS+j5sN+ynOfPd\nvv2mUEHJl5sycgkh1B0hTKCTQOqweXqJvN7T4KcdHpXWuxR0DOrN80cBNf6P\n/sN9UB+q7UjYO8KJsHLWeqgwsbQsnCtyJkspHsYDmMusj/oPt71y2w2Sxctf\nJrdV0fqiHc1BY1WBazuW6Bb0GlS1sH7XUwRODXKNj4dnzePKUYD7Pf5faLrZ\nkjIEKLM0Xrl44Zd7I+aSVytwjFy5EAbB4Mu5e94JJJMNT4BnVt+vjGH1AdTB\n/OlcPS6YnV3vtJk6CuN5Oy9s2t1kBLa+rW5Ce5wcrEypIUF7T8DoGlD/mUGi\nvqo2\r\n=BRH9\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\n> This is the README for beta releases. The \"stable\" (but still v0) release is here: https://github.com/pacocoursey/use-descendants/tree/v0\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@beta\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 --jsx React.createElement","prepublish":"yarn build"},"_npmUser":{"name":"paco","email":"pvco.coursey@gmail.com"},"description":"> This is the README for beta releases. The \"stable\" (but still v0) release is here: https://github.com/pacocoursey/use-descendants/tree/v0","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.5_1626132504930_0.9411503086285742","host":"s3://npm-registry-packages"},"_id":"use-descendants@1.0.0-beta.5","version":"1.0.0-beta.5"}