Skip to content

mParticle/aquarium

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

835 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

higgs_aquarium

  

Aquarium — Rokt UI Library

Component library for Rokt applications, built on top of Ant Design.

Components That Scale

Installation

Setup with LLM

Requirements

Dependency Version Notes
React >=19.0.0 React 19+
React DOM >=19.0.0 Must match React version
Node.js >=24.12.0 For development

Quick Start

yarn add @mparticle/aquarium antd@6 dayjs@1

Or with npm:

npm install @mparticle/aquarium antd@6 dayjs@1

Setup

Add the CSS reset to your app entry point (_app.tsx, layout.tsx, or index.tsx):

import 'antd/dist/reset.css'

Usage

import { Button, Space, Typography } from '@mparticle/aquarium'
import { PaddingSm } from '@mparticle/aquarium/dist/style'

export const MyComponent = () => {
  return (
    <Space direction="vertical">
      <Typography.Title level={3}>Hello Aquarium</Typography.Title>
      <Typography.Text>Successfully installed!</Typography.Text>
      <Space>
        <Button type="primary" style={{ paddingLeft: PaddingSm }}>
          Primary
        </Button>
        <Button>Default</Button>
      </Space>
    </Space>
  )
}

Adopting Aquarium

New to Aquarium? See ADOPTING.md for a step-by-step onboarding guide.

Requesting Components

Need a component that doesn't exist yet? Open a Component Request on GitHub Issues.

Development

Clone the repository and install dependencies:

git clone git@github.com:mParticle/aquarium.git
cd aquarium
npm install

Run Storybook for local development:

npm run storybook

Run unit tests:

npm run test-storybook

Contributing

See CONTRIBUTING.md.

Please make sure any new or updated components are present, tested and verified within Storybook.

Support

  • Internal: Join the Aquarium GChat space for weekly updates and discussions
  • Public: GitHub Issues — component requests, bug reports, questions

License

Aquarium is available under the Apache License, Version 2.0. See the LICENSE file for more info.

About

mParticle Component Library

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors