{"id":20137823,"url":"https://github.com/scdh/seed-frontend-components","last_synced_at":"2026-06-05T06:31:25.296Z","repository":{"id":257083091,"uuid":"857124025","full_name":"SCDH/seed-frontend-components","owner":"SCDH","description":"Library of web components for building websites for digital editions.","archived":false,"fork":false,"pushed_at":"2025-07-09T09:29:10.000Z","size":2503,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-09T10:36:46.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/SCDH.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"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,"zenodo":null}},"created_at":"2024-09-13T21:13:53.000Z","updated_at":"2025-05-27T10:28:28.000Z","dependencies_parsed_at":"2024-09-14T19:32:20.789Z","dependency_job_id":"b6d2391d-d06b-4510-bc28-560662c5ccbb","html_url":"https://github.com/SCDH/seed-frontend-components","commit_stats":null,"previous_names":["scdh/seed-frontend-components"],"tags_count":40,"template":false,"template_full_name":null,"purl":"pkg:github/SCDH/seed-frontend-components","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fseed-frontend-components","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fseed-frontend-components/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fseed-frontend-components/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fseed-frontend-components/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SCDH","download_url":"https://codeload.github.com/SCDH/seed-frontend-components/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SCDH%2Fseed-frontend-components/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33932048,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-05T02:00:06.157Z","response_time":120,"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":[],"created_at":"2024-11-13T21:29:47.361Z","updated_at":"2026-06-05T06:31:25.290Z","avatar_url":"https://github.com/SCDH.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n\n\n# SEED Frontend Components\n\nThis is a collection of [web\ncomponents](https://developer.mozilla.org/en-US/docs/Web/API/Web_components)\nfor building web frontends for digital editions. It's part of the\nSEED, which is an acronym and stands for **S**EED **E**lectronic\n**Ed**itions. If you don't like recursion you can stick to **S**CDH\n**E**lectronic **Ed**itions ;-).\n\nWhy web components?\n\n- Flexibility: Developing web components does not entail a decision to\n  use a certain Javascript framework (React, Vue.js, next.js,\n  ...). They are framework-agnostic.  They can even be integrated in\n  Imperia or other CMSs.\n- Simple building blocks: Web components encapsulate complex functions\n  in custom HTML elements which are simple to use and simple to put\n  together. Have a look at the [examples folder](examples).\n- Suitable for complex frontends: Managing state is the most crucial\n  point in a complex web frontends. This collection of web components\n  uses [Redux Toolkit (RTK)](https://redux-toolkit.js.org/) for state\n  management: The Redux store is also encapsulated in a web\n  component. Again, this does not entail a decision for React as a\n  Javascript framework.\n\n\n## List of Web Components\n\nThese are the most important building blocks:\n\n- `\u003cseed-app\u003e`: a container element that provides app context (Redux\n  store, etc.) to descending elements\n- `\u003cseed-text-view\u003e`: an single HTML text in a `\u003ciframe\u003e` element with\n  features for setting up synoptical presentation of texts and\n  highlighting passages with annotations and selecting them.\n- `\u003cseed-annotation-permanent\u003e`: shows the last selected annotation\n- `\u003cseed-config\u003e`: an empty element for providing config options,\n  e.g., URLs where annotations or alignment information can be found\n\nRead the detailed documentation in the\n[Wiki](https://github.com/scdh/seed-frontend-components/wiki)!\n\n\n## Usage Examples\n\nSee the  [*example web pages*](#example-web-pages) section below.\n\nThere's also a list of real-world [*use cases*](#use-cases) below.\n\n\n## Getting started\n\n### Installation\n\nInstall from the open [npm\nregistry](https://zivgitlab.uni-muenster.de/SCDH/tei-processing/seed-frontend-components/-/packages)\nof the gitlab of University of Münster! The NPM package contains the\ncomponents in the `src` folder, but neither the index page nor the\n`examples`.\n\n\n#### Install\n\n```shell\nnpm i @scdh/seed-frontend-components\n```\n\n### Using the Compiled Library of Web Components\n\nInstead adding this package to the dependencies of your project, you\ncan simply load the compiled library of web components. The latest\nversion is only at\n\n```\nhttps://scdh.zivgitlabpages.uni-muenster.de/tei-processing/seed-frontend-components/seed-frontend-components.js\n```\n\nor\n\n```\nhttps://scdh.zivgitlabpages.uni-muenster.de/tei-processing/seed-frontend-components/seed-frontend-components.cjs\n```\n\n\n### Development\n\nRun a development server, accessible through `http://localhost:5173`:\n\n```shell\nnpm run dev\n```\n\nThis will serve pages like `index.html`.\n\nRun tests:\n\n```shell\nnpm run test\n```\n#### Example Web Pages\n\nRunning the [development server](#development) will bring up several\npages with usage examples. They are contained in the\n[`examples`](examples) folder.\n\n- [examples/synopsis.html](examples/synopsis.html) shows how to use\n  the web components for presenting several texts in parallel or\n  synoptically. The content is borrowed from a project about the book\n  of Ijob, but shortend. The presented files have some internal JS to\n  make the synchronized scrolling and highlighting the annotations\n  etc. work.\n\n#### API Docs\n\n[https://scdh.zivgitlabpages.uni-muenster.de/tei-processing/seed-frontend-components/docs/](https://scdh.zivgitlabpages.uni-muenster.de/tei-processing/seed-frontend-components/docs/)\n\n\n## Design Principles / Contributing\n\n1. Use RTK (Redux Toolkit) for state management.\n\n1. Write components the [Lit](https://lit.dev/docs/) way. Write view components!\n\n1. Prefer TS over JS.\n\n1. Do not configure the TS compiler to be tolerant when type checking.\n\n## Further Reading\n\n- [Lit documentation](https://lit.dev/docs/)\n\n- [Vite guide](https://vitejs.dev/guide/)\n\n## Use Cases\n\n- [Jiob Frontend](https://scdh.zivgitlabpages.uni-muenster.de/schnocks-ijob/hiob-synopsis-frontend/): a synoptical view of different versions of the book of Jiob with annotations\n- [4 Ezra](https://scdh.zivgitlabpages.uni-muenster.de/doering-4esra/esra-demo/): a synoptical view of various versions of the fourth book of Ezra\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Fseed-frontend-components","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscdh%2Fseed-frontend-components","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscdh%2Fseed-frontend-components/lists"}