Skip to main content

Component Reference

This page demonstrates all available callout styles and MDX components used throughout the Compass documentation. Use it as a quick reference when writing new docs.


Callouts (Admonitions)​

Callouts are used to highlight important information. Compass supports four types:

Info​

Use for general information, tips, or background context.

info

This is an info callout. Use it to provide helpful context or background information to the reader.

Tip​

Use for best practices, shortcuts, and recommended approaches.

tip

This is a tip callout. Use it to highlight productivity tips or recommended ways of doing something.

Warning​

Use for gotchas, deprecation notices, or non-critical cautions.

warning

This is a warning callout. Use it when the reader should proceed carefully or be aware of a potential issue.

Danger​

Use for destructive or irreversible actions only.

danger

This is a danger callout. Use it only for actions that could result in data loss or cannot be undone.


Callout with Custom Title​

You can override the default title of any callout:

Prerequisites

Before starting this module, make sure you have the Admin or Manager role assigned to your account.

Pro Tip

You can bulk-select items in any table by holding Shift and clicking the first and last row.


Code Blocks​

Inline code: use backticks for file names, values, and short code references.

Bash​

npm install
npm run start

JSON​

{
"project": "Hotel Opening",
"budget": 500000,
"currency": "USD"
}

TypeScript​

interface Project {
id: string;
name: string;
status: 'active' | 'completed' | 'archived';
budget: number;
}

Tables​

Column AColumn BColumn C
Value 1Value 2Value 3
Value 4Value 5Value 6
Value 7Value 8Value 9

Tabs​

Use <Tabs> to show alternative views — role-based content, OS-specific steps, or different workflows.

Admin Instructions​

As an Admin you can create, edit, and delete all projects in the system. Navigate to Settings → Projects to get started.


Cards​

Use <Card> for navigation tiles linking to related pages. Wrap in <CardGroup> to create a responsive grid.


Steps​

Use <Steps> for numbered, sequential procedures where the order matters.

Go to the sidebar and click Projects. The projects list will appear in the main content area.

Click "New Project"​

Select the + New Project button in the top-right corner of the page.

Fill in the Details​

Enter the project name, select a blueprint template (optional), and set the target completion date.

Save and Launch​

Click Create Project. You'll be redirected to the project dashboard where you can start adding tasks.


Accordion​

Use <Accordion> for collapsible FAQ sections or optional reference content that doesn't need to be visible by default.

Standalone​

Accordion Group​

Use <AccordionGroup> to visually group related accordions into a single bordered container:


Frame​

Use <Frame> to display screenshots or images with a consistent border and optional caption.

Screenshot not yet available. Add static/img/screenshots/projects-dashboard.png when ready.

Projects dashboard (screenshot placeholder)
Screenshots

The Frame component is ready. Screenshots will be added to this page when images are available from the Compass application.


Dark Mode​

All callouts, code blocks, and components support dark mode automatically. Toggle the theme using the 🌙 icon in the navbar to verify.