elements-ui

Elements UI

This project is in an early stage and lacks a complete documentation. A robust demo, docs site, and example projects are in development and expected to be completed in March 2020.

If you arrived here from the Gatsby Theme Store, Gatsby Theme Elements v1.0.7 is still available for download, but it will be deprecated with the next stable release of Elements UI.

Build React apps with a responsive layout system powered by Theme UI.

Elements UI helps you design accessible, responsive page templates that can be customized in an infinite number of ways. Use Elements to quickly deploy a polished site layout so you can focus on developing great content or adding new integrations to your site.

Elements UI extends all of Theme UI's core features so you can easily migrate your existing theme.

https://elements-ui.dev

Features

• 8 customizable header layouts
• 6 common page layouts
• Responsive header navigation
• Responsive side navigation
• Accessible dropdown menus
• Automatic skiplink and keyboard focus management
• Template component for plug-and-play layouts
• Multi-layout support
• Full Theme UI capabilities
  • Unlimited color modes
  • Responsive scales
  • Variant and sx prop support
  • MDX theming
  • 100% compatible with Theme UI components

Getting Started

npm i elements-ui

Elements UI uses two configuration objects and optional custom components to build your layouts. Your custom theme and options configurations determine how each layout should behave and appear.

See the documentation on how to build a theme and configure your layout options.

Template Component

To get a site up and running in less than 5 minutes, you can use the Template component. Simply import and supply your theme object, options object, menu array, and logo as props:

// basic template usage
import React from 'react'
import { Template } from 'elements-ui'

import theme from './my-theme'
import options from './my-options'
import menu from './my-menu'
import Logo from './Logo'

export default props => (
  <Template theme={theme} options={options} menu={menu} logo={<Logo />}>
    {props.children}
  </Template>
)

The Template component accepts a variety of props for custom components like a sidebar, side nav, header widgets (ie. search or social media links), footer content, and much more. Check out the Template docs for details.

Layout Components

If your design requires a bit more customization or if you need conditional layouts depending on a page route or variable, you can build with Elements UI's layout components:

// basic layout component usage
import React from 'react'
import {
  Layout,
  Header,
  Navbar,
  MobileMenu,
  Content,
  Main,
  Sidebar,
  Footer,
} from 'elements-ui'

import theme from './my-theme'
import options from './my-options'
import menu from './my-menu'
import Logo from './Logo'

export default props => (
  <Layout theme={theme} options={options}>
    <Header>
      <Navbar logo={<Logo />} menu={menu} />
      <MobileMenu menu={menu} />
    </Header>
    <Content>
      <Main>{props.children}</Main>
      <Sidebar>Your custom sidebar component</Sidebar>
    </Content>
    <Footer>Your custom footer</Footer>
  </Layout>
)

All layout components can be styled with custom variants and the sx prop.

Documentation - COMING SOON

Note: this is just an outline for planning purposes

• Design a Theme
• Configure Options
• Layout Components
• Template Component
• Custom Styles
• Adding Content
• API
• Tutorials

Upcoming Packages

• Common UI components
  • Image / video lightbox
  • Carousel slider
  • Reusable modal layer
  • Custom loaders
  • On-page search
  • Site search (Algolia)
  • Tab component
  • Responsive tables
  • Filterable grids
  • Scroll reveal
  • Scroll progress indicator
  • Mega dropdown menu
• Generative components
• Speech Synthesis component
• i18n support
• Pre-built themes
• Ecommerce & payment templates
• Authentication templates
• Blocks Editor compatibility

License

The MIT License (MIT)