{"id":15769666,"url":"https://github.com/digibib/deichman-ui","last_synced_at":"2025-05-08T19:36:53.030Z","repository":{"id":34068386,"uuid":"165822581","full_name":"digibib/deichman-ui","owner":"digibib","description":"Style-guide and component library","archived":false,"fork":false,"pushed_at":"2023-03-03T13:31:37.000Z","size":5404,"stargazers_count":5,"open_issues_count":10,"forks_count":1,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-04-14T18:14:04.702Z","etag":null,"topics":["postcss","react","storybook"],"latest_commit_sha":null,"homepage":"https://digibib.github.io/deichman-ui","language":"JavaScript","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/digibib.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2019-01-15T09:28:03.000Z","updated_at":"2024-02-15T15:09:57.000Z","dependencies_parsed_at":"2024-10-04T14:03:58.878Z","dependency_job_id":"72d4d2f9-764f-49c1-9f6f-8fb5acdedfd8","html_url":"https://github.com/digibib/deichman-ui","commit_stats":{"total_commits":375,"total_committers":12,"mean_commits":31.25,"dds":0.12,"last_synced_commit":"6219ced54ecf20aeb99d621e7fa3f9fc15cae4cd"},"previous_names":[],"tags_count":113,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digibib%2Fdeichman-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digibib%2Fdeichman-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digibib%2Fdeichman-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/digibib%2Fdeichman-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/digibib","download_url":"https://codeload.github.com/digibib/deichman-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253135463,"owners_count":21859647,"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":["postcss","react","storybook"],"created_at":"2024-10-04T14:03:51.792Z","updated_at":"2025-05-08T19:36:53.001Z","avatar_url":"https://github.com/digibib.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Deichman-ui\n\n![NPM version](https://img.shields.io/npm/v/@digibib/deichman-ui.svg)\n![Bundle size](https://badgen.net/bundlephobia/minzip/@digibib/deichman-ui)\n\nStyle-guide and component library for the Oslo public libraries\n\n- [Documentation](https://digibib.github.io/deichman-ui)\n- [Changelog](CHANGELOG.md)\n\n### Built with\n\n- [React](https://reactjs.org/)\n- [PostCSS](https://preset-env.cssdb.org/) CSS processing\n- [Backpack.css](https://github.com/chris-pearce/backpack.css) CSS foundation for applications\n- [Rollup](https://rollupjs.org/guide/en) JavaScript module bundler\n- [Storybook](https://storybook.js.org/) UI Development Environment\n\n### Developing\n\nLocal development is done via React-storybook. Clone the repo and run:\n\n```\n  npm i\n  npm start\n```\n\n### New components\n\nBefore adding a new Component, make sure this is a generic utility-component. If it's not, add it to the project where it will be used. I.E, an \"Accordion\" is generic, a \"LibraryDetailsCard\" is probably not.\n\n##### New component checklist:\n\n|     | Requirement                 | Description                                                                       |\n| --- | --------------------------- | --------------------------------------------------------------------------------- |\n| ✅  | The component is semantic   | Use HTML5 markup, the correct font hierarchy etc.                                 |\n| ✅  | The component is documented | Ensure the component has a `Component.md` file, a story and proptype definitions. |\n| ✅  | The component is accessible | Usable with a keyboard, correct `:focus`-styles, correct `aria-roles`.            |\n| ✅  | The component is tested     | Cross-browser testing.                                                            |\n\n### Icons\n\nAll icons are stored in the `/src/assets/icons` folder.\n\n##### Adding a new icon:\n\n- Export the icons for web!\n- It's important that they're as lean as possible since they'll be downloaded by all visitors. [Use this Optimizer if possible](https://petercollingridge.appspot.com/svg-optimiser).\n- Make sure the new icon has the same size/style/line width as the old files.\n- Add the icon to the folder and run `npm run icons`.\n- After the output file has been created (`public/icons.svg`), You need to manually replace any hex color values (taken from the source files) with `currentColor`. This will allow the icons to easily be colored when used. NB: Check the commit well to ensure you didn't edit any old icons/colors).\n- Add the new icon to the `stories/1-Base/3-icons.stories.js` file.\n- Publish new version of Deichman-UI.\n\n### Publishing\n\nMake sure to update the [changelog](CHANGELOG.md) if there's any breaking changes.\n\nTo publish a new version of the library to npm:\n\n```\n  npm version {major/minor/patch}\n  git push --tags\n  git push origin master\n  npm publish\n```\n\nTo publish/update the docs:\n\n```\n  npm run deploy-storybook\n```\n\n### CDN Cache\n\njsDelivr will cache the `@latest` tag for 24 hours, if you're using the latest version and wish to purge the cache, visit https://purge.jsdelivr.net/npm/@digibib/deichman-ui@latest/dist/index.css\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigibib%2Fdeichman-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdigibib%2Fdeichman-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdigibib%2Fdeichman-ui/lists"}