RCL Documentation

Documentation for the RCL

Table of Contents

• Overview
• Component sections
• Debug

Overview

pankosmia-rcl is the React Component Library shared by the Pankosmia clients. The components documented here are the ones in the v1.0 folder of the library (src/rcl/v1.0). They are exported from the package entry point and are built on top of MUI.

The library currently exports four v1.0 components:

• PanBasicDialog: a compact dialog for short confirmations and small forms.
• PanAdvancedDialog: a larger dialog that becomes full screen on small displays.
• PanDialogActionsArray: a helper that builds the close and action buttons given to the dialogs.
• PanMenuWrapper: a menu that is a popup on large screens and a bottom drawer on small screens.

Import them by name from the package:

import {
  PanBasicDialog,
  PanAdvancedDialog,
  PanDialogActionsArray,
  PanMenuWrapper,
} from "pankosmia-rcl";

Component sections

The components are documented by family. Each page explains every component of the family and each of its props:

• { site.data.i18n.pages.rcl_dialog.title[current_lang] }: PanBasicDialog, PanAdvancedDialog and PanDialogActionsArray.
• { site.data.i18n.pages.rcl_menu.title[current_lang] }: PanMenuWrapper.

Debug

The debug option lets the user see developer options. When it is turned on, every client that requires debug and is not excluded from the menu appears in the menu.

---

Contents

• Dialog
• Menu