{"id":14316747,"url":"https://github.com/damianricobelli/stepperize","last_synced_at":"2025-05-14T00:08:48.719Z","repository":{"id":232317281,"uuid":"784029241","full_name":"damianricobelli/stepperize","owner":"damianricobelli","description":"A library for creating step-by-step workflows in your apps","archived":false,"fork":false,"pushed_at":"2025-04-24T14:25:05.000Z","size":1853,"stargazers_count":1327,"open_issues_count":6,"forks_count":53,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-05-12T12:56:08.566Z","etag":null,"topics":["primitive","react","react-native","shadcn-ui","stepper","typesafe"],"latest_commit_sha":null,"homepage":"https://stepperize.vercel.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/damianricobelli.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-09T03:31:54.000Z","updated_at":"2025-05-11T01:45:24.000Z","dependencies_parsed_at":"2025-01-09T14:35:33.359Z","dependency_job_id":"40d8df6d-740a-4499-9141-1a9b916a38cc","html_url":"https://github.com/damianricobelli/stepperize","commit_stats":null,"previous_names":["damianricobelli/shadcn-stepper","damianricobelli/stepperize"],"tags_count":48,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianricobelli%2Fstepperize","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianricobelli%2Fstepperize/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianricobelli%2Fstepperize/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/damianricobelli%2Fstepperize/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/damianricobelli","download_url":"https://codeload.github.com/damianricobelli/stepperize/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253745046,"owners_count":21957315,"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","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":["primitive","react","react-native","shadcn-ui","stepper","typesafe"],"created_at":"2024-08-24T17:00:28.995Z","updated_at":"2025-05-14T00:08:43.711Z","avatar_url":"https://github.com/damianricobelli.png","language":"TypeScript","funding_links":[],"categories":["Libs and Components","TypeScript","Tools"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://stepperize.vercel.app/banner.png\" alt=\"Stepperize Logo\" /\u003e\n\u003c/p\u003e\n\n[![Build Size](https://img.shields.io/bundlephobia/minzip/@stepperize/react@latest?label=bundle%20size\u0026style=flat\u0026colorA=000000\u0026colorB=000000)](https://bundlephobia.com/result?p=@stepperize/react@latest)\n[![Version](https://img.shields.io/npm/v/@stepperize/react?style=flat\u0026colorA=000000\u0026colorB=000000)](https://www.npmjs.com/package/@stepperize/react)\n[![Downloads](https://img.shields.io/npm/dt/@stepperize/react.svg?style=flat\u0026colorA=000000\u0026colorB=000000)](https://www.npmjs.com/package/@stepperize/react)\n\nA library for creating step-by-step workflows in your apps\n\n- 🚀 Fast and efficient\n- 🔥 Powerful and flexible\n- 📦 Lightweight\n- 🪄 Fully type-safe\n- 🔗 Composable architecture\n- 🎨 Unstyled for maximum customization\n\n## Installation\n\n```bash\nnpm install @stepperize/react\n```\n\n## Quick Start\n\n1. Import the constructor:\n\n```tsx\nimport { defineStepper } from \"@stepperize/react\";\n```\n\n2. Define your steps:\n\n```tsx\nconst { Scoped, useStepper, steps, utils } = defineStepper(\n  { id: \"step-1\", title: \"Step 1\", description: \"Description for step 1\" },\n  { id: \"step-2\", title: \"Step 2\", description: \"Description for step 2\" },\n  { id: \"step-3\", title: \"Step 3\", description: \"Description for step 3\" },\n  { id: \"step-4\", title: \"Step 4\", description: \"Description for step 4\" }\n);\n```\n\n3. Use the hook in your components:\n\n```tsx\nfunction StepperComponent() {\n  const { currentStep, nextStep, prevStep } = useStepper();\n\n  return (\n    \u003cdiv\u003e\n      \u003ch2\u003e{currentStep.title}\u003c/h2\u003e\n      \u003cp\u003e{currentStep.description}\u003c/p\u003e\n      \u003cbutton onClick={prevStep}\u003ePrevious\u003c/button\u003e\n      \u003cbutton onClick={nextStep}\u003eNext\u003c/button\u003e\n    \u003c/div\u003e\n  );\n}\n```\n\n## How It Works\n\nStepperize allows you to define a series of steps with unique IDs. When you create your steps using `defineStepper`, you get:\n\n- A `Scoped` component for context management\n- A `useStepper` hook for step control\n- An array of `steps` for rendering\n- An `utils` object with useful functions\n\nThe only required field for each step is the `id`. You can add any additional properties you need, and they'll be fully type-safe when using the hook.\n\n## Documentation\n\nFor more detailed information on usage, configuration, and advanced features, visit our [full documentation](https://stepperize.vercel.app).\n\n## Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.\n\n## License\n\nStepperize is [MIT licensed](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianricobelli%2Fstepperize","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdamianricobelli%2Fstepperize","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdamianricobelli%2Fstepperize/lists"}