{"id":26455087,"url":"https://github.com/alexdisdier/react-helium","last_synced_at":"2025-03-18T20:29:56.766Z","repository":{"id":35785973,"uuid":"216643882","full_name":"alexdisdier/react-helium","owner":"alexdisdier","description":"a react components library","archived":false,"fork":false,"pushed_at":"2023-03-07T05:02:06.000Z","size":6017,"stargazers_count":4,"open_issues_count":12,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-11T10:42:09.152Z","etag":null,"topics":["atomic-design","circleci","codecov","draft-js","enzyme","react","semantic-release","storybook","typescript"],"latest_commit_sha":null,"homepage":"https://alexdisdier.github.io/react-helium/","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/alexdisdier.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-10-21T19:00:44.000Z","updated_at":"2023-12-31T23:29:20.000Z","dependencies_parsed_at":"2023-02-15T07:46:39.048Z","dependency_job_id":null,"html_url":"https://github.com/alexdisdier/react-helium","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexdisdier%2Freact-helium","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexdisdier%2Freact-helium/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexdisdier%2Freact-helium/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexdisdier%2Freact-helium/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexdisdier","download_url":"https://codeload.github.com/alexdisdier/react-helium/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244227449,"owners_count":20419253,"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":["atomic-design","circleci","codecov","draft-js","enzyme","react","semantic-release","storybook","typescript"],"created_at":"2025-03-18T20:29:56.278Z","updated_at":"2025-03-18T20:29:56.757Z","avatar_url":"https://github.com/alexdisdier.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm](https://img.shields.io/npm/v/react-helium)](https://www.npmjs.com/package/react-helium)\n[![CircleCI](https://circleci.com/gh/alexdisdier/react-helium.svg?style=svg)](https://circleci.com/gh/alexdisdier/react-helium)\n[![codecov](https://codecov.io/gh/alexdisdier/react-helium/branch/master/graph/badge.svg)](https://codecov.io/gh/alexdisdier/react-helium)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![](https://img.shields.io/bundlephobia/minzip/react-helium)](https://www.npmjs.com/package/react-helium)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n# React Helium library\n\n### 🚧 under construction 🚧\n\n## Usage Example\n\nSee demo - https://alexdisdier.github.io/react-helium/\n\n\u003chr\u003e\n\n## Getting Started\n\nIf you wish to use this components' library in your project.\n\n```bash\nnpm install react-helium\n\nor\n\nyarn add react-helium\n```\n\nYou then need to pass a theme or use **react-helium** default.\nThis is usually done in the root level of your application.\n\ne.g: (using react-jss for styling)\n\n```js\nimport React from 'react';\nimport { ThemeProvider } from 'react-jss';\nimport { theme, Button } from 'react-helium';\nimport 'react-helium/lib/style/base.css'; // Can be replaced with your custom reset.\n\n\u003cThemeProvider theme={theme}\u003e\n  \u003cdiv classname=\"root\"\u003e\n    \u003cButton onClick={() =\u003e alert('hello world')} round color=\"green\"\u003e\n      I am THE button\n    \u003c/Button\u003e\n  \u003c/div\u003e\n\u003c/ThemeProvider\u003e;\n```\n\n### Using react-helium\n\nYou can check out the [documentation using storybook](https://alexdisdier.github.io/react-helium/).\n\n## Install\n\nFor the commands, you can use either npm or yarn.\n\nClone this repository :\n\n```bash\ngit clone https://github.com/alexdisdier/react-helium.git\n\ncd react-helium\n```\n\n```bash\nyarn\n```\n\n## Running the components\n\nYou can use [storybook.js](https://storybook.js.org/) for running and visualizing the components:\n\nYou will get directions about each components usage, how to import them and the required and optional props.\n\n```bash\nyarn start\n```\n\nand visit [localhost:6007](http://localhost:6007)\n\n## Exporting Storybook\n\nBy exporting it as a static app, you can then serve your story on the network\n\n```bash\nyarn build-storybook\nnpx http-server .storybook-static\n```\n\n## Testing\n\n```bash\nyarn test:unit\n```\n\n```bash\nyarn test:coverage\n```\n\n## Release process\n\nReact-helium uses [`semantic-release`](https://github.com/semantic-release/semantic-release) to publish the package on the NPM registry.\n\nCommits need to respect the [Angular Commit message format](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines):\n\n#### Type\n\nMust be one of the following:\n\n- feat: A new feature\n- fix: A bug fix\n- docs: Documentation only changes\n- style: Changes that do not affect the meaning of the code (white-space, - formatting, missing semi-colons, etc)\n- refactor: A code change that neither fixes a bug nor adds a feature\n- perf: A code change that improves performance\n- test: Adding missing or correcting existing tests\n- chore: Changes to the build process or auxiliary tools and libraries such as documentation generation\n\n#### Scope\n\nThe scope could be anything specifying place of the commit change. For example $location, $browser, $compile, $rootScope, ngHref, ngClick, ngView, etc...\n\nYou can use \\* when the change affects more than a single scope.\n\n#### Subject\n\nThe subject contains succinct description of the change:\n\n- use the imperative, present tense: \"change\" not \"changed\" nor \"changes\"\n- don't capitalize first letter\n- no dot (.) at the end\n\n#### Breaking Changes\n\nIt should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.\n\nA few examples of commit messages:\n\n| Commit message                                                              | Release type           |\n| --------------------------------------------------------------------------- | ---------------------- |\n| fix(pencil): stop graphite breaking when too much pressure applied          | Patch Release          |\n| feat(pencil): add 'graphiteWidth' option                                    | Minor Feature Release  |\n| perf(pencil): remove graphiteWidth option                                   | Major Breaking Release |\n| BREAKING CHANGE: The graphiteWidth option has been removed. The default ... | Major Breaking Release |\n\n## Contribution\n\nI welcome any pull requests. I will soon draft a contributing document\n\n## License\n\nreact-helium is MIT licensed.\n\n## Acknowledgments\n\n- [Building Design Systems with Atomic Design](https://ubiedigital.com/atomic-design/)\n- [Typescript-cheatsheets](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet)\n- [Semantic-release](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/getting-started.md#getting-started)\n- [yalc](https://www.npmjs.com/package/yalc)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexdisdier%2Freact-helium","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexdisdier%2Freact-helium","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexdisdier%2Freact-helium/lists"}