{"id":13910970,"url":"https://github.com/Albejr/ngx-timeline","last_synced_at":"2025-07-18T10:32:05.599Z","repository":{"id":39562642,"uuid":"158581112","full_name":"Albejr/ngx-timeline","owner":"Albejr","description":"Component for rendering timelines from the your data.","archived":false,"fork":false,"pushed_at":"2024-06-01T11:50:01.000Z","size":1973,"stargazers_count":7,"open_issues_count":1,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-17T03:49:44.020Z","etag":null,"topics":["angular","component","json","timeline"],"latest_commit_sha":null,"homepage":"https://stackblitz.com/edit/ngx-timeline-albe","language":"SCSS","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/Albejr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2018-11-21T17:03:41.000Z","updated_at":"2024-06-01T11:50:05.000Z","dependencies_parsed_at":"2024-06-21T15:34:44.398Z","dependency_job_id":"493f380b-96ee-4a1d-8041-c22086eaa51f","html_url":"https://github.com/Albejr/ngx-timeline","commit_stats":{"total_commits":75,"total_committers":4,"mean_commits":18.75,"dds":0.3466666666666667,"last_synced_commit":"fbd46faeb68838aeddaa4d22afc5f2d1d6702c97"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Albejr/ngx-timeline","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Albejr%2Fngx-timeline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Albejr%2Fngx-timeline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Albejr%2Fngx-timeline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Albejr%2Fngx-timeline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Albejr","download_url":"https://codeload.github.com/Albejr/ngx-timeline/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Albejr%2Fngx-timeline/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265687203,"owners_count":23811220,"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":["angular","component","json","timeline"],"created_at":"2024-08-07T00:01:52.561Z","updated_at":"2025-07-18T10:32:05.291Z","avatar_url":"https://github.com/Albejr.png","language":"SCSS","funding_links":[],"categories":["SCSS"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\u003ci\u003eAlbe Timeline \u003csup\u003e1.7.0\u003c/sup\u003e\u003c/i\u003e\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\u003ci\u003eAlbe Timeline is a simple yet highly customizable component that helps you render a responsive horizontal (or vertical) timeline from JSON data. The data will be automatically grouped by year and the events will be sorted by date.\u003c/i\u003e\u003c/p\u003e\n\n- Content HTML highly manipulable.\n- Styles for the template are easily customizable.\n- Simplifies the aspects of internationalization, displaying dates and alternatives texts in a local format.\n\nVersion history:\n| Library | Angular |\n| ------- | ------- |\n| Lastet | 18.0.1 |\n| 1.6.0 | 17.3.0 |\n| 1.5.0 | 16.0.0 |\n| 1.4.1 | 15.2.6 |\n| 1.3.0 | 14.2.0 |\n| 1.2.11 | 11.2.4 |\n| 1.2.0 | 10.1.2 |\n| 1.1.0 | 8.0.0 |\n\n## Use license\nThe component is open source and released for free commercial use at no cost. Donations are welcome.\n\n## Installation\n```html\n$ npm install ngx-timeline-albe\n```\n\n## How to use\n### Import the module\n```typescript\nimport { NgxTimelineAlbeModule } from 'ngx-timeline-albe';\n\n@NgModule({\n    imports: [ NgxTimelineAlbeModule ],\n    ...\n})\nexport class AppModule {}\n```\n\n### Template\n```html\n\u003cngx-timeline [itens]=\"data\"\u003e\u003c/ngx-timeline\u003e\n```\n\n* Instance with options:\n```html\n\u003cngx-timeline [itens]=\"data\" \n    [formatDate]=\"'dd MMMM'\" \n    [sortDesc]=\"true\"\n    [showMenu]=\"true\" \n    [showGroup]=\"true\" \n    [theme]=\"'basic'\"\u003e\n\u003c/ngx-timeline\u003e\n```\n\n### Component\n```typescript\nimport { TimelineItem } from 'ngx-timeline-albe';\n```\n```typescript\n  //The Json object is also accepted in string format.\n  data: Array\u003cTimelineItem\u003e | String;\n```\n```typescript\nngOnInit() {\n\n    //Object type\n    this.data = [\n      {\n        datetime: new Date('2020-03-29 23:59:59'),\n        header: 'Sample of header',\n        body: [\n          {\n            tag: 'h1',\n            content: \"Lorem ipsum\"\n          },\n          {\n            tag: 'p',\n            content: 'Lorem ipsum dolor sit amet, nisl lorem, wisi egestas orci tempus class massa.'\n          }],\n        footer: 'Sample of footer. See \u003ca href=\\\"https://github.com/Albejr/ngx-timeline\\\" target=\\\"_blank\\\"\u003emore details\u003c/a\u003e'\n      }\n    ];\n\n    //OR Json format\n    this.data = `[{\n      \"datetime\": \"2020-03-29 23:59:59\",\n      \"header\": \"Sample of header\",\n      \"body\": [{\n          \"tag\": \"h1\",\n          \"content\": \"Lorem ipsum\"\n        },\n        {\n          \"tag\": \"p\",\n          \"content\": \"Lorem ipsum dolor sit amet, nisl lorem, wisi egestas orci tempus class massa.\"\n        }\n      ],\n      \"footer\": \"Sample of footer. See \u003ca href='https://github.com/Albejr/jquery-albe-timeline' target='_blank'\u003emore details\u003c/a\u003e\"\n    }]`;\n  }\n```\n\n### Options\n\n| Name           |          | Type                               | Default   | Description                                                                                       |\n| -------------- | -------- | ---------------------------------- | --------- | ------------------------------------------------------------------------------------------------- |\n| [itens]        | required | `Array\u003cTimelineItem\u003e` or `String Json` | [ ]       | List of itens to be displayed.                                                                    |\n| [showGroup]    | optional | Boolean                            | true      | Sets the visibility of the annual grouper. |\n| [showMenu]     | optional | Boolean                            | true      | Sets the anchor menu visibility for annual groupings (depends on 'showGroup'). |\n| [sortDesc]     | optional | Boolean                            | true      | Defines ordering of items, true: Descendente, false: Ascendente. |\n| [formatDate]   | optional | String                             | 'dd MMMM' | Sets the date display format: \u003cul\u003e\u003cli\u003e'dd MMMM'\u003c/li\u003e\u003cli\u003e'dd/MM/yyyy HH:mm:ss'\u003c/li\u003e\u003cli\u003e'MM/dd/yyyy'\u003c/li\u003e\u003cli\u003e'yyyy/MM/dd'\u003c/li\u003e\u003c/ul\u003e |\n| [language]     | optional | String                             | 'pt-BR'   | Specifies manually the display language of texts (i18n), if the token LocaleID is not configured. |\n| [theme]        | optional | String                             | 'basic'   | Defines the style: \u003cul\u003e\u003cli\u003e'basic'\u003c/li\u003e\u003cli\u003e'horizontal'\u003c/li\u003e\u003cli\u003e'minimalist'\u003c/li\u003e\u003cli\u003e'mobile'\u003c/li\u003e\u003cli\u003e'vertical'\u003c/li\u003e\u003c/ul\u003e |\n\n#### TimelineItem Type\n\n| Name     |          | Type              | Description                |\n| -------- | -------- | ----------------- | -------------------------- |\n| datetime | required | Date              |                            |\n| icon     | optional | string            |                            |\n| header   | optional | string            |                            |\n| body     | required | `Array\u003cItemBody\u003e` |                            |\n| footer   | optional | string            |                            |\n\n#### ItemBody Type\n\n| Name    |          | Type           | Description                |\n| ------- | -------- | -------------- | -------------------------- |\n| tag     | required | string         |                            |\n| content | required | string         |                            |\n| attr    | optional | `TagAttribute` |                            |\n\n#### TagAttribute Type\n\n| Name     |          | Type   | Description                |\n| -------- | -------- | ------ | -------------------------- |\n| href     | optional | string |                            |\n| target   | optional | string |                            |\n| title    | optional | string |                            |\n| src      | optional | string |                            |\n| width    | optional | string |                            |\n| cssclass | optional | string |                            |\n\n## Html Structure\nWe'll have a similar result:\n```html\n\u003cngx-timeline\u003e\n    \u003cdiv id=\"timeline-albe\" class=\"clasic\"\u003e\n        \u003csection\u003e\n            \u003cheader class=\"group\"\u003e2020\u003c/header\u003e\n            \u003cdiv class=\"item\"\u003e\n                \u003cdiv class=\"badge\"\u003e\n                    \u003cspan\u003e29/03\u003c/span\u003e\n                \u003c/div\u003e\n                \u003carticle\u003e\n                    \u003cheader\u003eSample of header\u003c/header\u003e\n                    \u003cdiv class=\"body\"\u003e\n                        \u003cspan\u003e2017-03-29 23:59:59\u003c/span\u003e\n                        \u003ch1\u003eLorem ipsum\u003c/h1\u003e\n                        \u003cp\u003eLorem ipsum dolor sit amet, nisl lorem, wisi egestas orci tempus class massa.\u003c/p\u003e\n                    \u003c/div\u003e\n                    \u003cfooter\u003eSample of footer.\u003c/footer\u003e\n                \u003c/article\u003e\n                \u003cdiv class=\"badge last\"\u003e\n                \u003c/div\u003e\n            \u003c/div\u003e\n        \u003c/section\u003e\n    \u003c/div\u003e\n\u003cngx-timeline\u003e\n```\n\n## Styling guide\n\nThere are several classes that help you to create your custom styles\n`app.component.css`\n```css\n:host ::ng-deep #timeline-albe.minimalist {\n  color: inherit;\n  font-size: inherit;\n  width: inherit;\n  margin: 10px;\n}\n```\n\n## Notes\n* The **datetime** element must meet the ISO 8601 standard in year-month-day format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\"\n\n## Demo App\nFollow these instructions to run the demo:\n\n1. Clone the repository to your local machine\n2. From the project folder, run `npm i` to install all required dependencies\n3. Run `ng b ngx-timeline-albe` to build in **dist** folder.\n4. Run `ng s` to serve the project from a live-updating server.\n5. Go to `localhost:4200` to see the demo site\n\n\n## To do\n- [x] If 'json' (string) is passed, convert to 'object'.\n- [x] Displays default message.\n- [ ] Insert animation.\n- [x] Sort items by date.\n- [x] Multiple languages.\n- [x] Multiple styles.\n- [ ] Document CSS customization.\n- [x] Document 'json' or 'object'.\n\n\u003eInspired on the plug-in: https://github.com/Albejr/jquery-albe-timeline\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlbejr%2Fngx-timeline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAlbejr%2Fngx-timeline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAlbejr%2Fngx-timeline/lists"}