noham/gitprofile
1
0
Fork 0
mirror of https://github.com/NohamR/gitprofile.git synced 2026-05-25 04:17:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add type definition for all props

Browse Source
This commit is contained in:
Ariful Alam
2022-03-26 18:26:04 +06:00
parent 4cb107e168
commit 2743dee9aa
3 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -153,7 +153,7 @@ const config = {
// Useful if you want to support a single color mode // Useful if you want to support a single color mode
disableSwitch: false, disableSwitch: false,
// Should we use the prefers-color-scheme media-query, // Should use the prefers-color-scheme media-query,
// using user system preferences, instead of the hardcoded defaultTheme // using user system preferences, instead of the hardcoded defaultTheme
respectPrefersColorScheme: true, respectPrefersColorScheme: true,

6
gitprofile.config.js
View File

@@ -91,14 +91,14 @@ const config = {
snippetVersion: 6, snippetVersion: 6,
}, },
themeConfig: { themeConfig: {
default: 'corporate', defaultTheme: 'corporate',
// Hides the switch in the navbar // Hides the switch in the navbar
// Useful if you want to support a single color mode // Useful if you want to support a single color mode
disableSwitch: false, disableSwitch: false,
// Should we use the prefers-color-scheme media-query, // Should use the prefers-color-scheme media-query,
// using user system preferences, instead of the hardcoded default // using user system preferences, instead of the hardcoded defaultTheme
respectPrefersColorScheme: false, respectPrefersColorScheme: false,
// Available themes. To remove any theme, exclude from here. // Available themes. To remove any theme, exclude from here.

19
types/index.d.ts vendored
View File

@@ -135,9 +135,24 @@ export interface ThemeConfig {
defaultTheme: string; defaultTheme: string;
/** /**
* Snippet Version * Hides the switch in the navbar
*/ */
snippetVersion: number; disableSwitch: boolean;
/**
* Should use the prefers-color-scheme media-query
*/
respectPrefersColorScheme: boolean;
/**
* Available themes
*/
themes: Array<string>;
/**
* Custom theme
*/
customTheme: object;
} }
export interface Config { export interface Config {