Skip to content

Added helper.d.ts File #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wottpal wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Added helper.d.ts File #36

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1953633
Added helper.d.ts File
wottpal Sep 15, 2021
dd36855
Add declaration for `enable`-function
wottpal Sep 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions helper.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* To initialize nightwind, add the following script tag to the head element of your pages.
*
* ```
* import nightwind from "nightwind/helper"
*
* export default function Layout() {
* return (
* <>
* <Head>
* <script dangerouslySetInnerHTML={{ __html: nightwind.init() }} />
* </Head>
* // ...
* </>
* )
* }
* ```
*/
export declare function init(): string;
/**
* Similarly, you can use the toggle function to switch between dark and light mode.
* ```
* import nightwind from "nightwind/helper"
*
* export default function Navbar() {
* return (
* // ...
* <button onClick={() => nightwind.toggle()}></button>
* // ...
* )
* }
* ```
*/
export declare function toggle(): void;
/**
* You can use the enable function to specifically switch between dark and light mode.
* ```
* import nightwind from "nightwind/helper"
*
* export default function Navbar() {
* return (
* // ...
* <button onClick={() => nightwind.enable(true)}></button>
* // ...
* )
* }
* ```
*/
export declare function enable(dark: boolean): void;