Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.69 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.69 KB

Storybook

Maykin logo

Introduction

Admin-ui is the official (React) component library developed and maintained by Maykin Media, specifically designed for admin-like applications within our projects. It provides a consistent, efficient, and accessible foundation for application interfaces.

By standardizing UI components, Admin-ui helps teams streamline development, ensure a cohesive user experience, and reduce maintenance overhead across multiple projects.

Project goals

  • Consistency – Maintain a uniform UI across all Maykin Media admin panels, dashboards, and tools.
  • Efficiency – Speed up development with ready-to-use components optimized for admin workflows.
  • Accessibility – Ensure compliance with WCAG standards by default.

Getting Started

Installation:

npm install @maykin-ui/admin-ui

Using templates:

import { ListTemplate } from "@maykin-ui/admin-ui";

<ListTemplate dataGridProps={{objectList: []}} />

Using components:

import { Button } from "@maykin-ui/admin-ui";

<Button variant="primary">Primary Button</Button>

Documentation & Storybook

For an overview of available components, templates, and usage examples, visit the Storybook environment:

Admin-ui Storybook

Storybook provides interactive documentation, allowing you to explore and test components in isolation.