{"id":22912097,"url":"https://github.com/artempchela/dark-mode-react","last_synced_at":"2025-05-09T01:41:14.946Z","repository":{"id":65102288,"uuid":"547901409","full_name":"ArtemPchela/dark-mode-react","owner":"ArtemPchela","description":"React dark-mode base on Reac.js. No TypeScript, no Vite.","archived":false,"fork":false,"pushed_at":"2022-12-28T12:59:11.000Z","size":766,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-31T20:42:37.477Z","etag":null,"topics":["dark-mode","dark-mode-react","dark-theme","notypescript","novite","react","reactjs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/dark-mode-react","language":"JavaScript","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/ArtemPchela.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":"2022-10-08T14:24:17.000Z","updated_at":"2023-07-25T01:12:07.000Z","dependencies_parsed_at":"2023-01-13T15:33:56.344Z","dependency_job_id":null,"html_url":"https://github.com/ArtemPchela/dark-mode-react","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtemPchela%2Fdark-mode-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtemPchela%2Fdark-mode-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtemPchela%2Fdark-mode-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArtemPchela%2Fdark-mode-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArtemPchela","download_url":"https://codeload.github.com/ArtemPchela/dark-mode-react/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253176420,"owners_count":21866141,"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":["dark-mode","dark-mode-react","dark-theme","notypescript","novite","react","reactjs"],"created_at":"2024-12-14T04:20:05.149Z","updated_at":"2025-05-09T01:41:14.912Z","avatar_url":"https://github.com/ArtemPchela.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# dark-mode-react\n\n[![Npm package version](https://badgen.net/npm/v/dark-mode-react)](https://npmjs.com/package/dark-mode-react)\n[![Npm package total downloads](https://badgen.net/npm/dt/dark-mode-react)](https://npmjs.com/package/dark-mode-react)\n[![Npm package daily downloads](https://badgen.net/npm/dw/dark-mode-react)](https://npmjs.com/package/dark-mode-react)\n[![Npm package daily downloads](https://badgen.net/npm/dd/dark-mode-react)](https://npmjs.com/package/dark-mode-react)\n[![Npm package license](https://badgen.net/npm/license/lodash)](https://npmjs.com/package/dark-mode-react)\n\n\u003e NOTE: react dark mode based on \"react\": \"^18.2.0\" and \"react-dom\": \"^18.2.0\".\n\u003e The user setting persists to `localStorage`.\n\n### dark-mode-react:\n\n\u003cul\u003e\n    \u003cli\u003ea minimal lightweight component for your React projects.\u003c/li\u003e\n    \u003cli\u003equickly setup\u003c/li\u003e\n    \u003cli\u003ehas a small bundle size and zero dependencies\u003c/li\u003e\n    \u003cli\u003eyou have total control with styles - css, scss, sass, tailwind ui.\u003c/li\u003e\n    \u003cli style=\"color: red\"\u003e\u003cb\u003eDoesn't support Vite and TS\u003c/b\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n### If you would like to switch your React app on [Vite](https://vitejs.dev/) or [TypeScript](https://www.typescriptlang.org/docs/handbook/react.html) or both of them. Install [dark-mode-ts](https://www.npmjs.com/package/dark-mode-ts) version. \n\nDon't forget about ⭐ [GitHub](https://github.com/ArtemPchela/dark-mode-react)\n\n```jsx\nimport React from 'react';\nimport {Theme} from \"dark-mode-react\";\nimport yourDarkImage from './path/to/your/DarkImage.png'\nimport yourLightImage from './path/to/your/LightImage.png'\n\nconst NameYourComponent = () =\u003e {\n  return (\n    \u003cdiv\u003e\n      \u003cTheme\n        darkIcon={yourDarkImage}\n        lightIcon={yourLightImage}\n        altDark='dark icon'\n        altLight=\"light icon\"\n        imgWidth='50'\n        imgHeight='50'\n        myClass=\"your-class_name\"\n      /\u003e\n    \u003c/div\u003e\n  )\n};\n```\n\nA React theme component accepts the following props:\n\n| Key         | Type   | Description                                                          |\n|:------------|:-------|:---------------------------------------------------------------------|\n| `darkIcon`  | -      | Work with .png, .jpg, .svg\u003csup\u003e*\u003c/sup\u003e extensions.                   |\n| `lightIcon` | -      | Work with .png, .jpg, .svg\u003csup\u003e*\u003c/sup\u003e extensions.                   |\n| `altDark`   | string | For better accessibility.                                            |\n| `altLight`  | string | For better accessibility.                                            |\n| `imgWidth`    | string | Width for your icon.                                                 |\n| `imgHeight`   | string | Height for your icon.                                                |\n| `myClass`   | string | If you want to have background or add hover effect for icon wrapper. |\n\n\u003csup\u003e*\u003c/sup\u003e - Don't **forget**, **svg** has width and height by **default**.\n\n## Add your global styles. Example:\n\n```css\n:root {\n  --background-color: #007aff;\n  --color-text: white;\n}\n\n[data-theme='light'] {\n  --background-color: #227d2c;\n  --color-text: black\n}\n\nbody {\n  background: var(--background-color);\n  color: var(--color-text);\n}\n```\n\n## Installation\n\n```sh\n$ npm i dark-mode-react\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartempchela%2Fdark-mode-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartempchela%2Fdark-mode-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartempchela%2Fdark-mode-react/lists"}