{"id":26221044,"url":"https://github.com/timdehof/shadcn-timeline","last_synced_at":"2025-04-07T14:11:31.756Z","repository":{"id":231010130,"uuid":"780582361","full_name":"timDeHof/shadcn-timeline","owner":"timDeHof","description":"Customizable and re-usable timeline component for you to use in your projects. Built on top of shadcn. ","archived":false,"fork":false,"pushed_at":"2025-01-03T23:22:11.000Z","size":1626,"stargazers_count":177,"open_issues_count":1,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-07T14:11:13.466Z","etag":null,"topics":["nextjs","nextjs14","react","react-component","shadcn","shadcn-ui","ui-library"],"latest_commit_sha":null,"homepage":"https://timdehof.github.io/shadcn-timeline/","language":"JavaScript","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/timDeHof.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":"timDeHof","thanks_dev":null,"custom":null}},"created_at":"2024-04-01T19:19:02.000Z","updated_at":"2025-04-04T12:44:43.000Z","dependencies_parsed_at":"2024-04-08T01:24:05.304Z","dependency_job_id":"ba6b5499-6e1d-45a2-907e-235cf9721c73","html_url":"https://github.com/timDeHof/shadcn-timeline","commit_stats":null,"previous_names":["timdehof/shadcn-timeline"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timDeHof%2Fshadcn-timeline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timDeHof%2Fshadcn-timeline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timDeHof%2Fshadcn-timeline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timDeHof%2Fshadcn-timeline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timDeHof","download_url":"https://codeload.github.com/timDeHof/shadcn-timeline/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247666014,"owners_count":20975788,"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":["nextjs","nextjs14","react","react-component","shadcn","shadcn-ui","ui-library"],"created_at":"2025-03-12T15:51:31.824Z","updated_at":"2025-04-07T14:11:31.731Z","avatar_url":"https://github.com/timDeHof.png","language":"JavaScript","funding_links":["https://buymeacoffee.com/timDeHof","https://www.buymeacoffee.com/timDeHof"],"categories":[],"sub_categories":[],"readme":"# Shadcn Timeline Component\n\u003ca href=\"https://www.buymeacoffee.com/timDeHof\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 60px !important;width: 217px !important;\" \u003e\u003c/a\u003e\n\nA beautiful, accessible, and customizable timeline component built  on top of \u003ca href=\"https://shadcn.com\" target=\"_blank\"\u003eshadcn/ui\u003c/a\u003e with React and Tailwind CSS.\n\nThe same as shadcn/ui, all components are free to use for personal and commercial.\n\nJust copy and paste to your project and customize to your needs. The code is yours.\n\n## Demo \u0026 Documentation\n\n- 🔗 [View Storybook Documentation](https://timdehof.github.io/shadcn-timeline/)\n- 🔗 [Live Demo](https://shadcn-timeline.vercel.app/)\n\n## Features\n\n- 🎨 Customizable appearance with different sizes and colors\n- ♿️ Fully accessible with ARIA attributes\n- 🔄 Loading and error states\n- 🎭 Smooth animations with Framer Motion\n- 📱 Responsive design\n- 🎯 TypeScript support\n- 🌐 SSR Compatible\n- 📚 Full Storybook documentation and examples\n\n## Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/timDeHof/shadcn-timeline.git\n\n# Install dependencies\nnpm install\n\n# Run Storybook locally\nnpm run storybook\n```\n\n## Usage\n\n```tsx\nimport { Timeline, TimelineItem } from '@/components/timeline';\nimport { Check } from 'lucide-react';\n\nexport default function Example() {\n  return (\n    \u003cTimeline\u003e\n      \u003cTimelineItem\n        date={new Date('2024-01-01')}\n        title=\"Feature Released\"\n        description=\"New timeline component is now available\"\n        icon={\u003cCheck /\u003e}\n        status=\"completed\"\n      /\u003e\n      \u003cTimelineItem\n        date={new Date('2024-01-02')}\n        title=\"In Progress\"\n        description=\"Working on documentation\"\n        status=\"in-progress\"\n      /\u003e\n      \u003cTimelineItem\n        date={new Date('2024-01-03')}\n        title=\"Upcoming\"\n        description=\"Planning future updates\"\n        status=\"pending\"\n      /\u003e\n    \u003c/Timeline\u003e\n  );\n}\n```\n\n## Props\n\n### Timeline\n\n| Prop     | Type                 | Default | Description          |\n| -------- | -------------------- | ------- | -------------------- |\n| size     | 'sm' \\| 'md' \\| 'lg' | 'md'    | Size of the timeline |\n| iconsize | 'sm' \\| 'md' \\| 'lg' | 'md'    | Size of icons        |\n\n### TimelineItem\n\n| Prop        | Type                                            | Default     | Description              |\n| ----------- | ----------------------------------------------- | ----------- | ------------------------ |\n| date        | Date \\| string \\| number                        | -           | Date of the event        |\n| title       | string                                          | -           | Title of the event       |\n| description | string                                          | -           | Description of the event |\n| icon        | ReactNode                                       | -           | Custom icon              |\n| iconColor   | 'primary' \\| 'secondary' \\| 'muted' \\| 'accent' | 'primary'   | Color theme of the icon  |\n| status      | 'completed' \\| 'in-progress' \\| 'pending'       | 'completed' | Current status           |\n| loading     | boolean                                         | false       | Show loading state       |\n| error       | string                                          | -           | Show error state         |\n\n### TimelineTime\n\n| Prop      | Type                                 | Default | Description             |\n| --------- | ------------------------------------ | ------- | ----------------------- |\n| date      | Date \\| string \\| number             | -       | Date to display         |\n| format    | string \\| Intl.DateTimeFormatOptions | -       | Date formatting options |\n| className | string                               | -       | Additional CSS classes  |\n\n## Server-Side Rendering\n\nThe component is fully SSR compatible and handles hydration properly. Date formatting is handled on the client side to prevent hydration mismatches.\n\n## Development\n\nTo run Storybook locally:\n\n```bash\nnpm run storybook\n```\n\nThis will start Storybook on http://localhost:6006\n\n## Testing\n\nRun the test suite:\n\n```bash\n# Run tests\nnpm run test\n\n# Run Storybook tests\nnpm run test-storybook\n\n# Run Storybook tests with coverage\nnpm run test-storybook:coverage\n```\n## Contributing\n- [Open an issue](https://github.com/timDeHof/shadcn-timeline/issues) if you believe you've encountered a bug.\n- Make a [Pull request](https://github.com/timDeHof/shadcn-timeline/pulls) if you want to add a new feature/make quality of life improvements/ fix bugs.\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimdehof%2Fshadcn-timeline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimdehof%2Fshadcn-timeline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimdehof%2Fshadcn-timeline/lists"}