Package Exports
- @banzamel/mineralui
- @banzamel/mineralui/cards
- @banzamel/mineralui/controls
- @banzamel/mineralui/cookie-consent-bootstrap
- @banzamel/mineralui/data
- @banzamel/mineralui/display
- @banzamel/mineralui/dropdowns
- @banzamel/mineralui/feedback
- @banzamel/mineralui/form
- @banzamel/mineralui/i18n
- @banzamel/mineralui/icons
- @banzamel/mineralui/illustrations
- @banzamel/mineralui/inputs
- @banzamel/mineralui/layout
- @banzamel/mineralui/media
- @banzamel/mineralui/overlays
- @banzamel/mineralui/primitives
- @banzamel/mineralui/styles.css
- @banzamel/mineralui/theme
- @banzamel/mineralui/typography
- @banzamel/mineralui/utils
Readme
MineralUI
Modern React UI framework with a sharp admin aesthetic, theming system, and production-ready components.
- npm:
@banzamel/mineralui - version:
1.0.7 - peer dependencies:
react >= 19,react-dom >= 19 - repository:
https://github.com/Banzamel/mineralui - homepage:
https://mineralui.io - styles: bundled and auto-injected on component import
Installation
npm install @banzamel/mineraluiNo separate CSS import is required.
Package Structure
MineralUI is maintained from one source tree and released in two package variants:
@banzamel/mineraluiPublic Basic package published on npmjs.@banzamel/mineralui-proPrivate full package distributed separately with premium components and product modules.
The public repository is the source of truth for the framework and can generate both release packages.
Quick Start
import {MThemeProvider, MCard, MCardHeader, MCardBody, MInput, MSelect, MButton} from '@banzamel/mineralui'
function AccountSettings() {
return (
<MThemeProvider mode="dark">
<MCard>
<MCardHeader title="Workspace settings" description="Basic account data and role assignment." />
<MCardBody>
<MInput label="Workspace name" placeholder="Banzamel Studio" fullWidth />
<MSelect
label="Default role"
fullWidth
options={[
{value: 'owner', label: 'Owner'},
{value: 'editor', label: 'Editor'},
]}
/>
<MButton>Save changes</MButton>
</MCardBody>
</MCard>
</MThemeProvider>
)
}Included In Basic
- theming and i18n providers
- layout primitives for dashboards and docs shells
- controls, inputs, overlays, cards, tables, galleries, typography and utilities
- grouped subpath exports such as:
@banzamel/mineralui/layout@banzamel/mineralui/controls@banzamel/mineralui/data@banzamel/mineralui/feedback@banzamel/mineralui/theme
Pro Surface
The Pro package extends the Basic package with premium modules currently marked in framework licensing metadata, including:
- advanced data modules such as
MFileManager,MCalendarBoard,MChat - premium display modules such as
MStepper,MTimeline,MQrCode - premium cards, charts, media, cookie-consent system,
MTopbar, andMIconV2
The produced Pro archive can then be uploaded to your package distribution backend.
## Design Notes
MineralUI is token-driven and override-friendly:
- CSS variables in `--mineral-*`
- plain CSS with readable class names
- dark and light mode through one token system
- scoped overrides through `MThemeProvider`
- no runtime dependencies besides React peer dependencies
## Links
- Website: `https://mineralui.io`
- Documentation: `https://mineralui.io/docs`
- npm: `https://www.npmjs.com/package/@banzamel/mineralui`