{"id":26605851,"url":"https://github.com/patternfly-webcomponents/patternfly-webcomponents","last_synced_at":"2025-04-09T19:22:54.615Z","repository":{"id":57320856,"uuid":"72454055","full_name":"patternfly-webcomponents/patternfly-webcomponents","owner":"patternfly-webcomponents","description":"This project provides a set of core Web Components for the PatternFly reference implementation","archived":false,"fork":false,"pushed_at":"2017-09-01T11:07:03.000Z","size":10117,"stargazers_count":19,"open_issues_count":16,"forks_count":10,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-03-20T15:52:54.752Z","etag":null,"topics":["bootstrap","css","javascript","webcomponents"],"latest_commit_sha":null,"homepage":"https://patternfly-webcomponents.github.io/","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/patternfly-webcomponents.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-31T16:12:08.000Z","updated_at":"2024-03-04T21:41:15.000Z","dependencies_parsed_at":"2022-08-25T21:01:05.571Z","dependency_job_id":null,"html_url":"https://github.com/patternfly-webcomponents/patternfly-webcomponents","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly-webcomponents%2Fpatternfly-webcomponents","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly-webcomponents%2Fpatternfly-webcomponents/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly-webcomponents%2Fpatternfly-webcomponents/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patternfly-webcomponents%2Fpatternfly-webcomponents/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patternfly-webcomponents","download_url":"https://codeload.github.com/patternfly-webcomponents/patternfly-webcomponents/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248095712,"owners_count":21046897,"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":["bootstrap","css","javascript","webcomponents"],"created_at":"2025-03-23T21:16:42.271Z","updated_at":"2025-04-09T19:22:54.592Z","avatar_url":"https://github.com/patternfly-webcomponents.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PatternFly Web Components\nThis project will provide a set of core web components for the [PatternFly](https://www.patternfly.org) project.\n\n![Image of PatternFly](https://raw.githubusercontent.com/patternfly-webcomponents/patternfly-webcomponents/master/icons/patternfly-webcomponents.png)\n\nhttps://patternfly-webcomponents.github.io/\n\nNote: This project is in alpha state and currently makes use of [Patternfly 4](https://github.com/patternfly/patternfly) / Bootstrap 3 CSS. In future releases, we will add support for [Patternfly 5](https://github.com/patternfly/patternfly-css) / Bootstrap 4 Atomic CSS.\n\n## Getting Started\n```\n   npm install --save patternfly-webcomponents\n```\n\n### JS\nInclude `dist\\js\\patternfly.js` to load all components or load the `*.js` components individually.\n\n### CSS\nLoad the web component CSS in `dist\\css\\patternfly-webcomponents.css` alongside Patternfly CSS.\n\n### API Docs\nAPI documentation for each component is generated with [JSDocs](http://usejsdoc.org/). You can view these docs here:\n\nhttps://patternfly-webcomponents.github.io/patternfly-webcomponents/\n\n### Build\n    npm install\n    gulp build\n\n### Serve\n    gulp serve\nURL: http://localhost:3000/index.html\n* Uses gulp watch and browser-sync\n\n![image](https://cloud.githubusercontent.com/assets/12733153/20062925/69b80140-a4d3-11e6-87d7-b2f523b1b869.png)\n\n### Testing\nUnit and Peformance test notes can be found in [TESTS.md](TESTS.md)\n\nTest pages for each component can also be found at the following url:\nhttps://rawgit.com/patternfly-webcomponents/patternfly-webcomponents/master-dist/index.html\n\n## Tech Notes\nRepository uses the following:\n\n* Babel - Essentially an ECMAScript 6 to ECMAScript 5 Javascript compiler. It allows you to use ES6 features in your projects and then compiles ES5 for you to use in production.\n* Plumber - Prevent pipe breaking caused by errors from gulp plugins\n* Webpack - Webpack is a module bundler. Webpack takes modules with dependencies and generates static assets representing those modules.\n\n## Gotchas\nIf you choose to include components individually, you will also want to include `dist\\js\\customElementShim.js`. This resolves an issue currently with the HTMLElement prototype in Safari.\n\n[Source](https://github.com/babel/babel/issues/1548)\n\n## Git Commit Guidelines\n\nPatternFly Web Components uses a semantic release process to automate package publishing, based on the following commit message format.\n\nEach commit message consists of a **header**, a **body** and a **footer**.  The header has a special\nformat that includes a **type**, a **scope** and a **subject** ([full explanation](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md)):\n\n```\n\u003ctype\u003e(\u003cscope\u003e): \u003csubject\u003e\n\u003cBLANK LINE\u003e\n\u003cbody\u003e\n\u003cBLANK LINE\u003e\n\u003cfooter\u003e\n```\n\n##### Patch Release\n\n```\nfix(pencil): stop graphite breaking when too much pressure applied\n```\n\n##### Feature Release\n\n```\nfeat(pencil): add 'graphiteWidth' option\n```\n\n##### Breaking Release\n\n```\nperf(pencil): remove graphiteWidth option\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatternfly-webcomponents%2Fpatternfly-webcomponents","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatternfly-webcomponents%2Fpatternfly-webcomponents","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatternfly-webcomponents%2Fpatternfly-webcomponents/lists"}