1.13.1 • Published 1 week ago
@splunk/themes
Licence
Apache-2.0
Version
1.13.1
Deps
4
Size
2.3 MB
Vulns
0
Weekly
0
@splunk/themes
A collection of Splunk software theme variables and mixins. This package provides functions that can be useful in React, styled-components and other frameworks. Themes consist of plain objects containing primitives such as strings and numbers. Functions are used for mixins.
Install
Install the package:
yarn add @splunk/themes
-or-
npm install @splunk/themes
Peer-dependency notes
react@^18andstyled-components@^5"are required peer dependencies for all capabilities exceptgetTheme().
React Usage
A theme context is created at the root of the application using SplunkThemeProvider.
Apply pageBase() in app-level global styles with createGlobalStyle. pageBase() resets the browser's default page spacing
and applies theme-aware colors, typography, and layout styling to html and body.
import { createGlobalStyle } from 'styled-components';
import SplunkThemeProvider from '@splunk/themes/SplunkThemeProvider';
import { pageBase } from '@splunk/themes/mixins';
const GlobalStyles = createGlobalStyle`
html,
body {
${pageBase()}
}
`
<SplunkThemeProvider family="prisma" density="compact" colorScheme="light">
<GlobalStyles />
...
</SplunkThemeProvider>;
Styled Components Usage
Components are themed using pick(), variables, mixins.
import { pick, variables, mixins } from '@splunk/themes';
import styled from 'styled-components';
const Wrapper = styled.div`
${mixins.reset()};
color: ${pick({
enterprise: variables.textColor,
prisma: variables.contentColorDefault
})};
`;
Generic Usage
Theme variables are also available outside of React and styled-components.
import getTheme from '@splunk/themes/getTheme';
const baseTheme = getTheme({family: 'prisma', colorScheme: 'light', density: 'compact' });
console.log(baseTheme.family, baseTheme.focusColor);