0.3.25 • Published 3 years ago

bisma-ui v0.3.25

Weekly downloads
-
License
-
Repository
github
Last release
3 years ago

Background

Motivasi pengembangan bisma-ui dilakukan untuk mempercepat pengembangan UI serta memudahkan koordinasi antar developer baik dari internal developer maupun eksternal. Template bisma-ui dibuat menggunakan Mazer yang dimodifikasi sedemikian rupa agar sesuai dengan desain UI bisma.

Instalasi

Bisma-ui tersedia di npm dan dapat di install dengan perintah command line. Berikut adalah tahapan instalasi dan penggunaan : 1. Install bisma-ui npm i bisma-ui

  1. Tambahkan baris css dibawah pada file css yang di import di nextjs / react. Misalnya terdapat komponen sidebar.js yang mengimport file css bernama style.module.css, maka pada file style.module.css tambahkan baris dibawah : @import url('https://firecek.com/cdn-bisma/assets/css/main.css');

  2. Installasi sudah selesai.

Dokumentasi

  1. Building Block UI
  2. Komponen UI

    a. Layout

    b. UI Blocks

    c. Full example

  3. Component API

Building Block

Sebelum ke implementasi kode, dibawah adalah gambar building block yang membangun bisma-ui menjadi satu kesatuan.

Layout 1 (<Template1/>)

Bisma-UI building block - Template 1

Layout 2 (<Template2/>)

Bisma-UI building block - Template 2

Komponen UI

Layout

Template1

<Template1
  miniSidebar={
    <MiniSidebar></MiniSidebar>
  }

  profile={
    <a href="/some-icon">
        <img src={Avatar} alt="avatar" />
    </a>
  }

  module={[
    {
      title: "Penjualan",
      url: "/sales"
    }
  ]}

  mainSidebar={
    <MenuList></MenuList>
  }

  content={
    <div className="page-heading"></div>
  }
/>

Template2

<Template1
  miniSidebar={
    <MiniSidebar></MiniSidebar>
  }

  profile={
    <a href="/some-icon">
        <img src={Avatar} alt="avatar" />
    </a>
  }

  module={[
    {
      title: "Penjualan",
      url: "/sales"
    }
  ]}

  content={
    <div className="page-heading"></div>
  }
/>

UI Blocks

Buidling block bisma-ui terdiri dari :

Mini sidebar

Contoh kode :

<MiniSidebar>
    <a href="/">
        <img src={Dashboard} alt="Dashboard" width="45px" style={{ margin: '10px' }} />
    </a>
    <a href="/notification">
        <img src={Notification} alt="Notification" width="45px" style={{ margin: '10px' }} />
    </a>
    <a href="/some-icon">
        <img src={SomeIcon} alt="" width="45px" style={{ margin: '10px' }} />
    </a>
</MiniSidebar>

Main sidebar

Contoh kode :

<MenuList>
    <Menu url="/" content={
        <a href="/">Dashboard</a>
    } />
    <Menu url="/sample-1" content={
        <a href="/sample-1">Sample 1</a>
    } />
    <Menu url="#" content={
        <a href="#">OKOKO</a>
    }>
        <SubMenu url="/okoko/submenu-1">
            <a href='/okoko/submenu-1'>
                Submenu 1
            </a>
        </SubMenu>
        <SubMenu url="/okoko/submenu-2">
            <a href='/okoko/submenu-2'>
                Submenu 2
            </a>
        </SubMenu>
    </Menu>
</MenuList>

Module

Contoh kode :

[
    {
        title: "Penjualan",
        url: "/sales"
    },
    {
        title: "Pengadaan",
        url: "/pengadaan"
    }
]

Profile

Contoh kode :

profile={
    <a href="/some-icon">
        <img src={'./assets/icons/avatar.svg'} alt="avatar" />
    </a>
}

Content

Contoh kode :

<div className="page-heading">
    <div className="page-title">
        <div className="row">
            <div className="col-12 col-md-6 order-md-1 order-last">
                <h3>Vertical Layout with Navbar</h3>
                <p className="text-subtitle text-muted">Navbar will appear in top of the page.</p>
            </div>
            <div className="col-12 col-md-6 order-md-2 order-first">
                <nav aria-label="breadcrumb" className="breadcrumb-header float-start float-lg-end">
                    <ol className="breadcrumb">
                        <li className="breadcrumb-item"><a href="index.html">Dashboard</a></li>
                        <li className="breadcrumb-item active" aria-current="page">Layout Vertical Navbar
                        </li>
                    </ol>
                </nav>
            </div>
        </div>
    </div>
    <section className="section">
        <div className="card">
            <div className="card-header">
                <h4 className="card-title">Example Content</h4>
            </div>
            <div className="card-body">
                Lorem ipsum dolor sit amet consectetur adipisicing elit. Consectetur quas omnis
                laudantium tempore
                exercitationem, expedita aspernatur sed officia asperiores unde tempora maxime odio
                reprehenderit
                distinctio incidunt! Vel aspernatur dicta consequatur!
            </div>
        </div>
    </section>
</div>

Full code example

import { Template1, Menu, MenuList, SubMenu, MiniSidebar } from 'bisma-ui'

import Dashboard from './lib/component/assets/icons/dashboard.svg';
import Notification from './lib/component/assets/icons/notification.svg';
import SomeIcon from './lib/component/assets/icons/some-icon.svg';

function App() {
  return (
    <div className="App">
      <Template1
        miniSidebar={
          <MiniSidebar>
            <a href="/">
              <img src={Dashboard} alt="Dashboard" width="45px" style={{ margin: '10px' }} />
            </a>
            <a href="/notification">
              <img src={Notification} alt="Notification" width="45px" style={{ margin: '10px' }} />
            </a>
            <a href="/some-icon">
              <img src={SomeIcon} alt="" width="45px" style={{ margin: '10px' }} />
            </a>
          </MiniSidebar>
        }

        module={[
          {
            title: "Penjualan",
            url: "/sales"
          },
          {
            title: "Pengadaan",
            url: "/pengadaan"
          }
        ]}

        profile={
            <a href="/some-icon">
                <img src={'./assets/icons/avatar.svg'} alt="avatar" />
            </a>
        }

        mainSidebar={
          <MenuList>
            <Menu url="/" content={
              <a href="/">Dashboard</a>
            } />
            <Menu url="/sample-1" content={
              <a href="/sample-1">Sample 1</a>
            } />
            <Menu url="#" content={
              <a href="#">OKOKO</a>
            }>
              <SubMenu url="/okoko/submenu-1">
                <a href='/okoko/submenu-1'>
                  Submenu 1
                </a>
              </SubMenu>
              <SubMenu url="/okoko/submenu-2">
                <a href='/okoko/submenu-2'>
                  Submenu 2
                </a>
              </SubMenu>
            </Menu>
          </MenuList>
        }

        content={
          <div className="page-heading">
            <div className="page-title">
              <div className="row">
                <div className="col-12 col-md-6 order-md-1 order-last">
                  <h3>Vertical Layout with Navbar</h3>
                  <p className="text-subtitle text-muted">Navbar will appear in top of the page.</p>
                </div>
                <div className="col-12 col-md-6 order-md-2 order-first">
                  <nav aria-label="breadcrumb" className="breadcrumb-header float-start float-lg-end">
                    <ol className="breadcrumb">
                      <li className="breadcrumb-item"><a href="index.html">Dashboard</a></li>
                      <li className="breadcrumb-item active" aria-current="page">Layout Vertical Navbar
                      </li>
                    </ol>
                  </nav>
                </div>
              </div>
            </div>
            <section className="section">
              <div className="card">
                <div className="card-header">
                  <h4 className="card-title">Example Content</h4>
                </div>
                <div className="card-body">
                  Lorem ipsum dolor sit amet consectetur adipisicing elit. Consectetur quas omnis
                  laudantium tempore
                  exercitationem, expedita aspernatur sed officia asperiores unde tempora maxime odio
                  reprehenderit
                  distinctio incidunt! Vel aspernatur dicta consequatur!
                </div>
              </div>
            </section>
          </div>
        }
      />
    </div>
  );
}

export default App;

API

Template1

Wrapper / pembungkus utama dari UI yang menggunakan layout pertama

PropertyDeskripsiTipeDefault
miniSidebarElement UI yang akan mengisi mini sidebar<MiniSidebar>-
mainSidebarElement UI yang akan mengisi main sidebar<MenuList>-
profileElement UI yang akan mengisi profilHTML/JSX-
moduleElement UI yang akan mengisi main moduleJSON-
contentElement UI yang akan mengisi main contentHTML/JSX-

Template2

Wrapper / pembungkus utama dari UI yang menggunakan layout kedua

PropertyDeskripsiTipeDefault
miniSidebarElement UI yang akan mengisi mini sidebar<MiniSidebar>-
contentElement UI yang akan mengisi main contentHTML/JSX-
profileElement UI yang akan mengisi profilHTML/JSX-

MenuList

Digunakan untuk membungkus <Menu> dan <Submenu>

PropertyDeskripsiTipeDefault
childrenElement yang akan dimasukkan sebagai menu / submenu<Menu>-

Menu

Digunakan untuk membungkus <Menu> dan <Submenu> didalam sidebar

PropertyDeskripsiTipeDefault
urlURL yang dituju ketika menu di klikString-
contentElement UI yang akan ditampilkanHTML/JSX-

SubMenu

Sebagai submenu / children dari <Menu>

PropertyDeskripsiTipeDefault
urlURL yang dituju ketika menu di klikString-
childrenElement UI yang akan ditampilkanHTML/JSX-

MiniSidebar

Wrapper / pembungkus mini sidebar dalam UI

PropertyDeskripsiTipeDefault
childrenElement UI yang akan ditampilkanHTML/JSX-
0.3.25

3 years ago

0.3.23

3 years ago

0.3.17

3 years ago

0.3.22

3 years ago

0.3.21

3 years ago

0.3.19

3 years ago

0.3.18

3 years ago

0.3.16

3 years ago

0.2.16

3 years ago

0.2.15

3 years ago

0.1.15

3 years ago

0.1.10

3 years ago

0.1.11

3 years ago

0.1.12

3 years ago

0.1.13

3 years ago

0.1.14

3 years ago

0.1.8

3 years ago

0.1.9

3 years ago

0.1.7

3 years ago

0.1.6

3 years ago

0.1.5

3 years ago

0.1.4

3 years ago

0.1.3

3 years ago

0.1.2

3 years ago

0.1.1

3 years ago

0.1.0

3 years ago