{"id":13773311,"url":"https://github.com/raisiqueira/headless-stepper-monorepo","last_synced_at":"2025-09-25T11:40:11.108Z","repository":{"id":38382128,"uuid":"468518176","full_name":"raisiqueira/headless-stepper-monorepo","owner":"raisiqueira","description":"Production ready React hook to create awesome stepper components. Effortless to use, easy to customize.","archived":false,"fork":false,"pushed_at":"2024-05-11T15:22:39.000Z","size":2173,"stargazers_count":55,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T07:43:28.639Z","etag":null,"topics":["accessibility","headless","headless-components","headlessui","nx","react","react-hooks","step-component","stepper","tabs-component"],"latest_commit_sha":null,"homepage":"https://headless-stepper.netlify.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/raisiqueira.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"raisiqueira","ko_fi":"raisiqueira"}},"created_at":"2022-03-10T21:37:47.000Z","updated_at":"2025-03-27T07:54:48.000Z","dependencies_parsed_at":"2023-12-09T18:24:28.301Z","dependency_job_id":"e0f6def3-0cfa-4260-9793-2a5e24502a69","html_url":"https://github.com/raisiqueira/headless-stepper-monorepo","commit_stats":{"total_commits":46,"total_committers":4,"mean_commits":11.5,"dds":0.06521739130434778,"last_synced_commit":"2750ad45bc18ef6e79f3a5e9d3b2bff331e8ee98"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/raisiqueira/headless-stepper-monorepo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raisiqueira%2Fheadless-stepper-monorepo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raisiqueira%2Fheadless-stepper-monorepo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raisiqueira%2Fheadless-stepper-monorepo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raisiqueira%2Fheadless-stepper-monorepo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/raisiqueira","download_url":"https://codeload.github.com/raisiqueira/headless-stepper-monorepo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/raisiqueira%2Fheadless-stepper-monorepo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271430764,"owners_count":24758366,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-21T02:00:08.990Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accessibility","headless","headless-components","headlessui","nx","react","react-hooks","step-component","stepper","tabs-component"],"created_at":"2024-08-03T17:01:14.177Z","updated_at":"2025-09-25T11:40:06.087Z","avatar_url":"https://github.com/raisiqueira.png","language":"TypeScript","funding_links":["https://github.com/sponsors/raisiqueira","https://ko-fi.com/raisiqueira"],"categories":["Libraries"],"sub_categories":[],"readme":"# headless-stepper\n\nProduction ready React hook to create awesome stepper components. Effortless to use, easy to customize.\n\n![npm bundle size](https://img.shields.io/bundlephobia/minzip/headless-stepper?style=flat-square)\n\n[Documentation](https://headless-stepper.netlify.app/) | [Issues](https://github.com/raisiqueira/headless-stepper-monorepo/issues)\n\n## Quick features\n\n- Headless.\n- 100% TypeScript.\n- No dependencies.\n- 100% customizable.\n\n## Start\n\nInstall the `headless-stepper` library using your favorite package manager:\n\n```bash\nnpm install headless-stepper\n# or using yarn\nyarn add headless-stepper\n# or using pnpm\npnpm install headless-stepper\n```\n\n## Using\n\nThe headless-stepper library provide two ways to build your stepper component:\n\n- Using the `Stepper` and `Step` components. See the [documentation](https://headless-stepper.netlify.app/getting-started/using-stepper) for more details.\n- Using the `useStepper` hook. See the [documentation](https://headless-stepper.netlify.app/getting-started/using) for more details.\n\n### Using the `Stepper` and `Step` components\n\nTo use the `Stepper` and `Step` components, you need to import the `Stepper` and `Step` components from the `headless-stepper` library.\n\n```tsx\nimport { Stepper, Step } from 'headless-stepper/components';\n\nconst MyAwesomeStepper = () =\u003e {\n  return (\n    \u003cStepper currentStep={0}\u003e\n      \u003cStep label=\"Step 1\"\u003eStep 1 content\u003c/Step\u003e\n\n      \u003cStep label=\"Step 2\"\u003eStep 2 content\u003c/Step\u003e\n\n      \u003cStep label=\"Step 3\"\u003eStep 3 content\u003c/Step\u003e\n    \u003c/Stepper\u003e\n  );\n};\n\nexport default MyAwesomeStepper;\n```\n\nUnder the hood, the `Stepper` component will use the `useStepper` hook to manage the state of the stepper. You can use the `useStepper` hook to build your own stepper component.\n\n### Using the `useStepper` hook\n\n```tsx\nimport React from 'react';\nimport { useStepper } from 'headless-stepper';\n\nexport interface HeadlessStepperProps {}\n\nexport function HeadlessStepper(props: HeadlessStepperProps) {\n  const steps = React.useMemo(\n    () =\u003e [\n      {\n        label: 'Step 1',\n      },\n      { label: 'Step 2' },\n      { label: 'Step 3' },\n      { label: 'Step 4', disabled: true },\n      { label: 'Step 5' },\n      { label: 'Step 6' },\n    ],\n    []\n  );\n  const { state, nextStep, prevStep, progressProps, stepsProps } = useStepper({\n    steps,\n  });\n  return (\n    \u003cdiv className={styles['container']}\u003e\n      \u003cdiv\u003e\n        \u003cnav style={{ display: 'flex' }}\u003e\n          {stepsProps?.map((step, index) =\u003e (\n            \u003col key={index}\u003e\n              \u003ca {...step}\u003e{steps[index].label}\u003c/a\u003e\n            \u003c/ol\u003e\n          ))}\n        \u003c/nav\u003e\n      \u003c/div\u003e\n      \u003cp\u003eCurrent step: {state.currentStep}\u003c/p\u003e\n      \u003cbutton\n        className=\"py-4 px-3 bg-blue-300\"\n        onClick={prevStep}\n        disabled={!state.hasPreviousStep}\n      \u003e\n        Prev\n      \u003c/button\u003e\n      \u003cbutton className=\"py-4 px-3 bg-blue-300\" onClick={nextStep}\u003e\n        Next\n      \u003c/button\u003e\n      \u003cdiv className=\"bg-gray-400 w-100% h-1/2\" {...progressProps} /\u003e\n    \u003c/div\u003e\n  );\n}\n\nexport default HeadlessStepper;\n```\n\nYou can find more examples on [documentation](https://headless-stepper.netlify.app/).\n\n## Contribute\n\nThis project was started with [Nx](https://nx.dev) to manage the monorepo. To learn more about Nx, read the [Nx documentation](https://nx.dev/).\n\nThe `headless-stepper` library and the documentation is under _packages_ folder. If you're running on local, execute the following command to start the development server:\n\n```bash\nnpm run dev\n```\n\nThe Storybook will be available on the localhost:4400 and refresh when you change the `useStepper` code.\n\n### Running unit tests\n\nRun `nx test headless-stepper` to execute the unit tests via [Vitest](https://vitest.dev).\n\n## Sponsors\n\n[![Sponsors](https://cdn.jsdelivr.net/gh/raisiqueira/static@master/sponsors.svg)](https://github.com/sponsors/raisiqueira)\n\n## License\n\nMIT @ Raí Siqueira.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraisiqueira%2Fheadless-stepper-monorepo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fraisiqueira%2Fheadless-stepper-monorepo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fraisiqueira%2Fheadless-stepper-monorepo/lists"}