MCPcopy Index your code
hub / github.com/EMCECS/clarity-react

github.com/EMCECS/clarity-react @v0.25.10

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.25.10 ↗ · + Follow
474 symbols 877 edges 141 files 1 documented · 0%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Clarity React Binding

This project an unofficial implementation of VMware Clarity Design in React. It leverages CSS, icons and images from the Clarity project.

Usage in React projects

To use the project simply add the dependencies with yarn, npm, etc:

$ yarn add @dellstorage/clarity-react

Import styles and globals from peer dependencies:

index.tsx

import "@webcomponents/custom-elements/custom-elements.min.js";
import "@clr/icons/clr-icons.min.css";
import "@clr/icons/clr-icons-lite.min.js";
import "@clr/ui/clr-ui.min.css"
import "@clr/icons/shapes/technology-shapes.js";

...

And make use of the components in your app:

App.tsx

```typescript jsx import React, {Component} from 'react'; import MainContainer from "@dell/clarity-react/layout/main-container/MainContainer";

const initialState = { };

type MainPageProps = { token?: string level?: string message?: string }

export type MainPageState = Readonly;

export default class MainPage extends Component { readonly state: MainPageState = initialState;

render() {
    return(
        <MainContainer>
            Hello
        </MainContainer>
    );
}

}


## Storybook

This project includes [Storybook](https://storybook.js.org/) as a component browser. To fire up storybook, download the project in Git:
```shell
$ git clone https://github.com/EMCECS/clarity-react.git

Install the dependencies with yarn, npm, etc.

$ cd clarity-react

# Using yarn
$ yarn

# Using NPM
$ npm install

Any run the "storybook" script:

# Using yarn
$ yarn run storybook

# Using NPM
$ npm run storybook

Licenses

  • Clarity React components is licensed under Apache 2.0 License.
  • The VMware Clarity Design System is licensed under the MIT license.

Extension points exported contracts — how you extend this code

VerticalNavGroupProps (Interface)
(no doc)
src/layout/vertical-nav/VerticalNavGroup.tsx
AlertProps (Interface)
(no doc)
src/emphasis/alert/Alert.tsx
IconProps (Interface)
(no doc)
src/icon/Icon.tsx
WizardFooterProps (Interface)
(no doc)
src/newWizard/WizardFooter.tsx
VerticalNavGroupState (Interface)
(no doc)
src/layout/vertical-nav/VerticalNavGroup.tsx

Core symbols most depended-on inside this repo

classNames
called by 115
src/utils.ts
checkStepValidity
called by 8
src/wizards/Wizard.tsx
getStepObj
called by 7
src/wizards/Wizard.tsx
modifyButtonStates
called by 7
src/wizards/Wizard.tsx
getPage
called by 6
src/datagrid/DataGrid.tsx
createElement
called by 5
src/toast/Toast.tsx
renderHelperText
called by 4
src/forms/input/Input.tsx
updateRowIDs
called by 4
src/datagrid/DataGrid.tsx

Shape

Method 235
Class 150
Function 44
Enum 40
Interface 5

Languages

TypeScript100%

Modules by API surface

src/datagrid/DataGrid.tsx44 symbols
src/wizards/Wizard.tsx31 symbols
src/forms/datepicker/DatePicker.tsx20 symbols
src/datagrid/DataGridStoriesData.tsx18 symbols
src/toast/Toast.tsx15 symbols
src/modals/Modal.tsx15 symbols
src/layout/vertical-nav/VerticalNav.tsx11 symbols
src/emphasis/alert/Alert.tsx10 symbols
src/datagrid/DataGridFilter.tsx10 symbols
src/forms/dropdown/Dropdown.tsx9 symbols
src/forms/datalist/DataList.tsx9 symbols
src/cards/Card.tsx9 symbols

For agents

$ claude mcp add clarity-react \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page