{"id":20001901,"url":"https://github.com/pooltogether/pooltogether-react-components","last_synced_at":"2025-05-04T15:33:33.266Z","repository":{"id":37991972,"uuid":"331815640","full_name":"pooltogether/pooltogether-react-components","owner":"pooltogether","description":"React UI components for PoolTogether.","archived":false,"fork":false,"pushed_at":"2023-01-18T20:49:38.000Z","size":38771,"stargazers_count":3,"open_issues_count":0,"forks_count":8,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-25T04:02:04.206Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/pooltogether.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2021-01-22T02:36:22.000Z","updated_at":"2023-03-15T17:16:13.000Z","dependencies_parsed_at":"2023-02-10T18:00:45.816Z","dependency_job_id":null,"html_url":"https://github.com/pooltogether/pooltogether-react-components","commit_stats":null,"previous_names":["pooltogether/pooltogether-react-tailwind-ui"],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-react-components","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-react-components/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-react-components/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pooltogether%2Fpooltogether-react-components/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pooltogether","download_url":"https://codeload.github.com/pooltogether/pooltogether-react-components/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252356537,"owners_count":21734973,"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":[],"created_at":"2024-11-13T05:19:03.923Z","updated_at":"2025-05-04T15:33:32.817Z","avatar_url":"https://github.com/pooltogether.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PoolTogether React Tailwind UI Components\n\nReact UI components using **tailwindcss**\n\n## Components:\n\nComponent Groups\n- [Buttons](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Buttons)\n- [Containers](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Containers)\n- [Icons](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Icons)\n- [Input](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Input)\n- [Layout](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Layout)\n- [Links](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Links)\n- [Loading](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Loading)\n- [Modal](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Modal)\n- [Navigation](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/Navigation)\n- [PageHeader](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/PageHeader)\n\nTop level components\n- [PageTitleAndBreadcrumbs](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/PageTitleAndBreadcrumbs.jsx)\n- [PoolCurrencyIcon](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/PoolCurrencyIcon.jsx)\n- [ThemeContextProvider](https://github.com/pooltogether/pooltogether-react-components/tree/main/src/components/ThemeContextProvider.jsx)\n\n## Installation:\n\n`yarn add @pooltogether/pooltogether-react-components`\n\n## Usage\n\nRequired:\n\n```js\n// tailwind.config.js\nconst pooltogetherTheme = require(\"@pooltogether/pooltogether-react-components\");\nmodule.exports = pooltogetherTheme({\n  purge: [],\n  theme: {\n    extend: {},\n  },\n  variants: {},\n  plugins: [],\n});\n```\n\nWrap your app in `ThemeContextProvider`\n```js\n// _app.jsx\nimport { ThemeContextProvider } from '@pooltogether/react-components'\nimport '@pooltogether/react-components/dist/globals.css'\n```\n\nNow you can use any components you want:\n\n```js\nimport React from \"react\";\nimport { Button } from \"@pooltogether/pooltogether-react-components\";\n\n\u003cButton type=\"submit\"\u003eSubmit\u003c/Button\u003e;\n\n// -------------------\n\nimport React from \"react\";\nimport Link from \"next/link\";\nimport { ButtonLink } from \"@pooltogether/pooltogether-react-components\";\n\n// External links\n\u003cButtonLink href={href}\u003eView\u003c/ButtonLink\u003e\n// Internal links\n\u003cLink as={'/home'} href={'/home'}\u003e\u003cButtonLink\u003eHome\u003c/ButtonLink\u003e\u003c/Link\u003e\n```\n\n## Local development (yalc)\n\nIn `pooltogether-react-components`:\n`yarn`\n`yalc publish`\n\nIn the app you're importing `pooltogether-react-components`:\n`yalc add @pooltogether/react-components`\n\n\n## Local development (yarn)\n\nTODO: Make this better...\n\nIn `pooltogether-react-components`:\n`yarn`\n`yarn link`\n\nIn the app you're importing `pooltogether-react-components`:\n`yarn link-components`\n\nIn `pooltogether-react-components`:\n`yarn link-local`\n`yarn start`\n\nIn the app you're importing `pooltogether-react-components`:\n`yarn dev`\n\nAnd your app will hot reload when changes are detected in the components folder!\n\n## Testing\n\n- `yarn test` will run jest\n\n# TODO:\n\n- integrate prettier/husky with our default prettier config\n- copy unit tests over and get them running in this lib\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fpooltogether-react-components","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpooltogether%2Fpooltogether-react-components","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpooltogether%2Fpooltogether-react-components/lists"}