• Stars
    star
    104
  • Rank 330,604 (Top 7 %)
  • Language
    JavaScript
  • Created almost 5 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A Frontity theme built with Chakra UI

Frontity Chakra Theme

A Frontity theme made with the Chakra UI library.

You can try it out in codesandbox: https://githubbox.com/chakra-ui/frontity-chakra-ui-theme

Installation guide

To get start quickly with the Chakra UI theme, you can install them like other published packages in Node using npm or yarn.

To install, run this command in your terminal:

npm install frontity-chakra-theme

Then add frontity-chakra-theme to your frontity.settings.js file.

If you want to modify this package, you need to install it as a local package. You can do so by following this guide: How to install a local package in Frontity.

Theme Options

Chakra theme can be configures via the frontity.settings.js file. The theme options can be specified in the state.theme property.

Key Default Value Description
menu [] The top level navigation links for your blog
socialLinks [] The social media links to use in your theme
logo [] The text or logo image url
showBackgroundPattern true If true, will show a backgroung pattern
showSocialLinks true If true, will show the social media links
colors The primary and accent colors to use

Example Usage

// frontity.settings.js
const settings = {
  packages: [
    {
      name: "frontity-chakra-theme",
      state: {
        theme: {
          // The logo can be a text or an image url
          logo: "Frontity",
          // show background pattern
          showBackgroundPattern: true,
          // show social links
          showSocialLinks: true,
          // the top-level navigation labels and links
          menu: [
            ["Home", "/"],
            ["Portfolio", "/portfolio"],
            ["About", "/about"],
            ["Contact", "/contact"],
          ],
          // the social links
          socialLinks: [
            ["pinterest", "https://www.pinterest.com/frontity/"],
            ["facebook", "https://www.instagram.com/frontity/"],
            ["twitter", "https://www.twitter.com/frontity/"],
          ],
          // color shades to use in the blog
          colors: {
            primary: {
              50: "#e9f5f2",
              100: "#d4dcd9",
              200: "#bbc3be",
              300: "#a1aba5",
              400: "#87938b",
              500: "#6d7972",
              600: "#555f58",
              700: "#323c34",
              800: "#232924",
              900: "#272727",
            },
            accent: {
              50: "#ede4d3",
              100: "#fbe3b2",
              200: "#f6d086",
              300: "#f1be58",
              400: "#eca419",
              500: "#d49212",
              600: "#a5710b",
              700: "#775105",
              800: "#483100",
              900: "#1d0f00",
            },
          },
        },
      },
    },
  ],
};

export default settings;

๐ŸšจNOTE: Since this theme is based on Chakra, we require that the theme colors should be color values from 50 - 900. For example, here's what the default colors look like:

// value of theme.colors
{
  "primary": {
    "50": "#e9f5f2",
    "100": "#d4dcd9",
    "200": "#bbc3be",
    "300": "#a1aba5",
    "400": "#87938b",
    "500": "#6d7972",
    "600": "#555f58",
    "700": "#323c34",
    "800": "#232924",
    "900": "#272727"
  },
  "accent": {
    "50": "#ede4d3",
    "100": "#fbe3b2",
    "200": "#f6d086",
    "300": "#f1be58",
    "400": "#eca419",
    "500": "#d49212",
    "600": "#a5710b",
    "700": "#775105",
    "800": "#483100",
    "900": "#1d0f00"
  }
}

You can use tools like Smart Swatch (https://smart-swatch.netlify.com/) or Palx (https://palx.jxnblk.com/) to generate color hues based on a single color

Additional Settings

In addition to the theme options, there are a handful of items you can customize via the frontity object in your siteโ€™s frontity.settings.js

// frontity.settings.js
const settings = {
  state: {
    frontity: {
      url: "your website url",
      title: "Your website title",
      description: "Your website description",
    },
  },
};

If you ever have questions, kindly post issues here or head over to https://community.frontity.org to get more personalizes support.

Enjoy the Chakra Theme โšก๏ธ

More Repositories

1

chakra-ui

โšก๏ธ Simple, Modular & Accessible UI Components for your React Applications
TypeScript
37,613
star
2

panda

๐Ÿผ Universal, Type-Safe, CSS-in-JS Framework for Product Teams โšก๏ธ
TypeScript
5,147
star
3

zag

Finite state machines for building accessible design systems and UI components. Works with modern frameworks, and even just Vanilla JS
TypeScript
3,969
star
4

ark

A headless library for building reusable, scalable design systems that works for a wide range of JS frameworks.
TypeScript
3,720
star
5

chakra-ui-vue

โšก๏ธ Build scalable and accessible Vue.js applications with ease.
JavaScript
1,865
star
6

awesome-chakra-ui

A collection of Chakra UI-related awesomeness
447
star
7

chakra-ui-docs

Documentation website for chakra ui
MDX
303
star
8

chakra-ui-vue-next

โšก๏ธ The next most epic version of Chakra UI Vue based on Vue 3 ๐Ÿš€(WIP)
TypeScript
261
star
9

zag-docs

Documentation website for Zag
TypeScript
127
star
10

polymorphic

Polymorphic component factories for JSX frameworks
TypeScript
73
star
11

eslint-plugin-panda

Official ESLint Plugin for Panda CSS
TypeScript
71
star
12

pro-component-issues

Bug fixes and feature request tracking for Chakra UI Pro.
62
star
13

design-vs-dev

This is the repo for Chakra UI's Design vs Dev Challenges. You can watch the YouTube series here: https://www.youtube.com/playlist?list=PLLh_woCGjyGqed2oBdr7K0r7HcS6X4DCH
TypeScript
56
star
14

panda-vscode

The official Panda CSS VSCode extension
TypeScript
48
star
15

play.chakra-ui.com

The Playground for Chakra UI
TypeScript
37
star
16

vscode-snippets

VSCode Snippets for Chakra UI
JavaScript
20
star
17

chakra-codemod

Codemod transformations to help upgrade to the latest Chakra UI
TypeScript
19
star
18

pro-theme

Chakra UI Pro Theme
TypeScript
17
star
19

panda-mastery-lessons

Panda Mastery Course Content (as Code)
TypeScript
14
star
20

vue-docs

Chakra UI Vue (v2) Official Documentation
TypeScript
13
star
21

chakra-loader

Chakra UI Vue webpack loader for auto-import and registration of Chakra components
JavaScript
13
star
22

panda-templates

Showcasing how to use Panda in various frameworks
11
star
23

vue-cli-plugin-chakra-ui

This plugin setups Chakra UI Vue in your Vue CLI generated projoect
JavaScript
8
star
24

chakra-ui-docusaurus

TypeScript
7
star
25

examples

Chakra UI example projects
7
star
26

chakra-ui-themes

TypeScript
6
star
27

figpilot-issues

Issue Tracker for FigPilot
5
star
28

rfcs

RFCs for Chakra UI
5
star
29

gatsby-starter-chakra-ui-ts

TypeScript
3
star
30

hackathon

TypeScript
1
star