{"id":13679463,"url":"https://github.com/feross/color-scheme-change","last_synced_at":"2025-09-10T20:36:25.953Z","repository":{"id":57203322,"uuid":"193385950","full_name":"feross/color-scheme-change","owner":"feross","description":"Detect system color scheme changes on the web (Dark Mode)","archived":false,"fork":false,"pushed_at":"2020-05-11T17:22:48.000Z","size":5,"stargazers_count":58,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T05:38:46.572Z","etag":null,"topics":["color-scheme","css","dark-mode","javascript","media-query","nodejs","prefers-color-scheme","web"],"latest_commit_sha":null,"homepage":"https://bitmidi.com","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/feross.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":"feross"}},"created_at":"2019-06-23T19:10:35.000Z","updated_at":"2024-01-09T10:24:32.000Z","dependencies_parsed_at":"2022-09-18T01:11:13.852Z","dependency_job_id":null,"html_url":"https://github.com/feross/color-scheme-change","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feross%2Fcolor-scheme-change","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feross%2Fcolor-scheme-change/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feross%2Fcolor-scheme-change/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/feross%2Fcolor-scheme-change/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/feross","download_url":"https://codeload.github.com/feross/color-scheme-change/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232808652,"owners_count":18579645,"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":["color-scheme","css","dark-mode","javascript","media-query","nodejs","prefers-color-scheme","web"],"created_at":"2024-08-02T13:01:05.808Z","updated_at":"2025-01-07T01:24:38.276Z","avatar_url":"https://github.com/feross.png","language":"JavaScript","funding_links":["https://github.com/sponsors/feross"],"categories":["JavaScript"],"sub_categories":[],"readme":"# color-scheme-change [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]\n\n[travis-image]: https://img.shields.io/travis/feross/color-scheme-change/master.svg\n[travis-url]: https://travis-ci.org/feross/color-scheme-change\n[npm-image]: https://img.shields.io/npm/v/color-scheme-change.svg\n[npm-url]: https://npmjs.org/package/color-scheme-change\n[downloads-image]: https://img.shields.io/npm/dm/color-scheme-change.svg\n[downloads-url]: https://npmjs.org/package/color-scheme-change\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n\n### Detect system color scheme changes on the web (Dark Mode)\n\nListen for changes to the system color scheme in the web browser. Detect when\nthe system switches between Light Mode and Dark Mode.\n\nBuilt for and used on [BitMidi](https://bitmidi.com), a free MIDI database. Works in the browser with [browserify](https://browserify.org/)!\n\n## install\n\n```\nnpm install color-scheme-change\n```\n\n## usage\n\n```js\nimport colorSchemeChange from 'color-scheme-change'\n\ncolorSchemeChange(colorScheme =\u003e {\n  console.log(`Entering ${colorScheme} mode`)\n  // Prints either \"Entering dark mode\" or \"Entering light mode\"\n})\n```\n\n## API\n\n### `remove = colorSchemeChange(onChange)`\n\nListen for changes to the system color scheme in the web browser. Detect when\nthe system switches between Light Mode and Dark Mode.\n\n#### `onChange`\n\nA callback function of the following interface: `function(colorScheme) {}` where\n`colorScheme` is either `'light'` or `'dark'`. The function is called whenever\nthe system enters Light Mode or Dark Mode, respectively.\n\n#### `remove`\n\nWhen the returned `remove` function is called, all event listeners are cleaned\nup and the `onChange` function will no longer be called when the system color\nscheme changes.\n\n## license\n\nMIT. Copyright (c) [Feross Aboukhadijeh](https://feross.org).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeross%2Fcolor-scheme-change","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffeross%2Fcolor-scheme-change","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffeross%2Fcolor-scheme-change/lists"}