Skip to content

Commit

Permalink
Fix typos (#39)
Browse files Browse the repository at this point in the history
Co-authored-by: Donavon West <[email protected]>
  • Loading branch information
jorgegonzalez and donavon authored Mar 13, 2020
1 parent 68c12ec commit e842948
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
declare module 'use-dark-mode' {
/**
* A config objet allowing you to specify certain aspects of `useDarkMode`
* A config object allowing you to specify certain aspects of `useDarkMode`
*/
export interface DarkModeConfig {
classNameDark?: string; // A className to set "dark mode". Default = "dark-mode".
classNameLight?: string; // A className to set "light mode". Default = "light-mode".
element?: HTMLElement; // The element to apply the className. Default = `document.body`
onChange?: (val?: boolean) => void; // Overide the default className handler with a custom callback.
storageKey?: string; // Specify the `localStorage` key. Default = "darkMode". Sewt to `null` to disable persistent storage.
storageKey?: string; // Specify the `localStorage` key. Default = "darkMode". Set to `null` to disable persistent storage.
storageProvider?: WindowLocalStorage; // A storage provider. Default = `localStorage`.
global?: Window; // The global object. Default = `window`.
}

/**
* An object returned frm a call to `useDarkMode`.
* An object returned from a call to `useDarkMode`.
*/
export interface DarkMode {
readonly value: boolean;
Expand Down

0 comments on commit e842948

Please sign in to comment.