Socket
Socket
Sign inDemoInstall

@nextui-org/theme

Package Overview
Dependencies
9
Maintainers
1
Versions
390
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@nextui-org/theme


Version published
Maintainers
1
Created

Package description

What is @nextui-org/theme?

@nextui-org/theme is a customizable theme package for the NextUI library, which provides a set of design tokens and utilities to create consistent and visually appealing user interfaces. It allows developers to easily define and apply themes across their applications.

What are @nextui-org/theme's main functionalities?

Custom Theme Creation

This feature allows developers to create custom themes by defining their own color schemes, typography, and other design tokens. The `createTheme` function is used to generate a theme object that can be applied to the application.

import { createTheme } from '@nextui-org/theme';

const myTheme = createTheme({
  type: 'dark',
  theme: {
    colors: {
      primary: '#ff4ecd',
      secondary: '#fefefe',
      background: '#000000'
    }
  }
});

Theme Provider

The `NextUIProvider` component is used to apply the custom theme to the entire application. By wrapping the application with `NextUIProvider` and passing the custom theme, all components within the application will adhere to the defined theme.

import { NextUIProvider } from '@nextui-org/react';
import { myTheme } from './myTheme';

function App() {
  return (
    <NextUIProvider theme={myTheme}>
      <YourComponent />
    </NextUIProvider>
  );
}

Using Theme Tokens

This feature allows developers to use theme tokens in their styled components. By using the `styled` function and referencing theme tokens (e.g., `$primary`, `$secondary`), developers can ensure that their components are consistent with the defined theme.

import { styled } from '@nextui-org/react';

const Button = styled('button', {
  backgroundColor: '$primary',
  color: '$secondary',
  padding: '10px 20px',
  borderRadius: '5px'
});

Other packages similar to @nextui-org/theme

Readme

Source

@nextui-org/theme

A Quick description of the component

This is an internal utility, not intended for public usage.

Installation

yarn add @nextui-org/theme
# or
npm i @nextui-org/theme

Contribution

Yes please! See the contributing guidelines for details.

Licence

This project is licensed under the terms of the MIT license.

Keywords

FAQs

Last updated on 26 Mar 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc