{"id":31043461,"url":"https://github.com/screentechnicals/tailwind-stepper","last_synced_at":"2026-04-12T00:10:15.369Z","repository":{"id":247396524,"uuid":"824689802","full_name":"ScreenTechnicals/tailwind-stepper","owner":"ScreenTechnicals","description":"Tailwind Stepper is a flexible UI component designed for React applications, integrating seamlessly with Tailwind CSS. It provides intuitive stepper interfaces for guided user interactions, enhancing usability and visual clarity in multi-step workflows.","archived":false,"fork":false,"pushed_at":"2024-11-23T18:46:59.000Z","size":48,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-12T16:48:53.519Z","etag":null,"topics":["javascript","nextjs","nodejs","react","rollupjs","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ScreenTechnicals.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-05T17:39:38.000Z","updated_at":"2024-11-23T18:47:02.000Z","dependencies_parsed_at":"2025-09-14T14:33:48.530Z","dependency_job_id":"43e97b91-53ef-4fdb-ac26-81a595170d87","html_url":"https://github.com/ScreenTechnicals/tailwind-stepper","commit_stats":null,"previous_names":["screentechnicals/tailwind-stepper"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ScreenTechnicals/tailwind-stepper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenTechnicals%2Ftailwind-stepper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenTechnicals%2Ftailwind-stepper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenTechnicals%2Ftailwind-stepper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenTechnicals%2Ftailwind-stepper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ScreenTechnicals","download_url":"https://codeload.github.com/ScreenTechnicals/tailwind-stepper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ScreenTechnicals%2Ftailwind-stepper/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279012027,"owners_count":26085041,"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-10-12T02:00:06.719Z","response_time":53,"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":["javascript","nextjs","nodejs","react","rollupjs","typescript"],"created_at":"2025-09-14T14:05:15.320Z","updated_at":"2025-10-12T16:48:54.434Z","avatar_url":"https://github.com/ScreenTechnicals.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tailwind Stepper Component\n\n**Tailwind Stepper** is a customizable React component designed to create intuitive step-by-step user interfaces using Tailwind CSS.\n\n## Installation\n\nInstall the package via npm or yarn or bun:\n\n```\nnpm install tailwind-stepper\n```\n\n```\nyarn add tailwind-stepper\n```\n\n\n\n```\nbun add tailwind-stepper\n```\n\n## Configuration\n\nadd the path for tailwind in the `tailwind.config.ts`\n\n```\nimport type { Config } from \"tailwindcss\";\n\nconst config: Config = {\n  content: [\n    \"...\",\n    \"./node_modules/tailwind-stepper/**/*.{js,ts,jsx,tsx,mdx}\",\n  ],\n  theme: {\n    extend: {\n      \"...\"\n    },\n  },\n  plugins: [\"...\"],\n};\n\nexport default config;\n\n```\n\n## Usage Example\n\nIntegrate the stepper component into your React application:\n\n```jsx\nimport React, { useState } from \"react\";\nimport { Stepper, Step } from \"tailwind-stepper\";\n\nconst steps: Step[] = [\n  { step: 0, label: \"Step 1\", content: \u003cdiv\u003eContent for Step 1\u003c/div\u003e },\n  { step: 1, label: \"Step 2\", content: \u003cdiv\u003eContent for Step 2\u003c/div\u003e },\n  { step: 2, label: \"Step 3\", content: \u003cdiv\u003eContent for Step 3\u003c/div\u003e },\n  { step: 3, label: \"Step 4\", content: \u003cdiv\u003eContent for Step 4\u003c/div\u003e },\n];\n\nconst App = () =\u003e {\n  const [selectedStep, setSelectedStep] = useState(0);\n\n  return (\n    \u003cStepper\n      selectedStep={selectedStep}\n      steps={steps}\n      orientation=\"horizontal\" // default\n      hideLabel={false}\n      classNames={{\n        base: \"...\",\n        divider: \"...\",\n      }}\n    /\u003e\n  );\n};\n\nexport default App;\n```\n\n## Component Props\n\n### Stepper Component\n\n| Prop           | Type                      | Description                                              |\n| -------------- | ------------------------- | -------------------------------------------------------- |\n| `selectedStep` | `number`                  | The currently selected step.                             |\n| `steps`        | `Step[]`                  | Array of steps to display.                               |\n| `orientation`  | `horizontal \\| vertical`  | Orientation of the stepper. Defaults to `'horizontal'`.  |\n| `hideLabel`    | `boolean`                 | Hides the labels of steps if `true`. Default is `false`. |\n| `classNames`   | `StepperClassNames`       | Custom class names for various components.               |\n\n### Step Object\n\n| Property  | Type              | Description                                       |\n| --------- | ----------------- | ------------------------------------------------- |\n| `step`    | `number`          | Step number.                                      |\n| `label`   | `string`          | Label for the step.                               |\n| `icon`    | `React.ReactNode` | Optional icon for the step.                       |\n| `content` | `React.ReactNode` | Optional content displayed when step is selected. |\n| `onClick` | `() =\u003e void`      | Optional click handler for the step.              |\n\n## Customization\n\nTailwind Stepper allows extensive customization through the `classNames` prop. You can style various elements:\n\n- `wrapper`: Wrapper around each step item.\n- `icon`: Icon inside each step item.\n- `label`: Label inside each step item.\n- `gradientBorder`: Gradient border for the selected step item.\n- `base`: Base class for the stepper container.\n- `divider`: Class for dividers between steps.\n\n## Example with Custom Class Names\n\n```jsx\n\u003cStepper\n  selectedStep={selectedStep}\n  steps={steps}\n  orientation=\"vertical\"\n  hideLabel={false}\n  classNames={{\n    base: \"...\",\n    wrapper: \"...\",\n    icon: \"...\",\n    label: \"...\",\n    gradientBorder: \"...\",\n    divider: \"...\",\n  }}\n/\u003e\n```\n\n## License\n\nThis project is licensed under the MIT License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreentechnicals%2Ftailwind-stepper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscreentechnicals%2Ftailwind-stepper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscreentechnicals%2Ftailwind-stepper/lists"}