1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-10-22 11:22:43 +02:00
metamask-extension/ui/components/component-library
George Marshall e96c0b6963
Update to component-library readme (#18501)
* Update to component-library readme

* Update ui/components/component-library/README.md

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>

---------

Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com>
2023-04-19 19:30:29 -07:00
..
avatar-account update text component color to use box color (#18246) 2023-03-23 13:00:37 -07:00
avatar-base Fix/18492/update icon ts app folder (#18645) 2023-04-19 14:16:49 -07:00
avatar-favicon UX Multichain: updated ethereum logo icon (#18528) 2023-04-19 20:55:19 +05:30
avatar-icon Fix/18492/update icon ts app folder (#18645) 2023-04-19 14:16:49 -07:00
avatar-network UX Multichain: updated ethereum logo icon (#18528) 2023-04-19 20:55:19 +05:30
avatar-token UX Multichain: updated ethereum logo icon (#18528) 2023-04-19 20:55:19 +05:30
badge-wrapper UX Multichain: updated ethereum logo icon (#18528) 2023-04-19 20:55:19 +05:30
banner-alert Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
banner-base update ButtonIcon to TS (#18448) 2023-04-12 08:55:24 -07:00
banner-tip Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
button Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
button-base Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
button-icon update ButtonIcon to TS (#18448) 2023-04-12 08:55:24 -07:00
button-link Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
button-primary Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
button-secondary Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
form-text-field Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
header-base Feat/18308/ds popover header component (#18489) 2023-04-19 10:36:01 -07:00
help-text Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
icon update ButtonIcon to TS (#18448) 2023-04-12 08:55:24 -07:00
input update text component color to use box color (#18246) 2023-03-23 13:00:37 -07:00
label Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
modal-content Adding ModalContent component (#18175) 2023-03-22 17:17:19 -07:00
modal-overlay Adding ModalOverlay component (#18161) 2023-03-23 06:36:09 -07:00
picker-network Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
popover-header Feat/18308/ds popover header component (#18489) 2023-04-19 10:36:01 -07:00
tag update text component color to use box color (#18246) 2023-03-23 13:00:37 -07:00
tag-url Updating icon imports to TS version in component-library folder (#18449) 2023-04-05 09:11:10 -07:00
text update to enum DS Text component (#18584) 2023-04-17 10:17:28 -07:00
text-field UX Multichain: updated ethereum logo icon (#18528) 2023-04-19 20:55:19 +05:30
text-field-search update ButtonIcon to TS (#18448) 2023-04-12 08:55:24 -07:00
COMPONENT-LIBARY.stories.mdx Adding readme for component-library folder (#15381) 2022-07-29 16:24:32 -05:00
component-library-components.scss Adding ModalOverlay component (#18161) 2023-03-23 06:36:09 -07:00
index.js Feat/18308/ds popover header component (#18489) 2023-04-19 10:36:01 -07:00
README.md Update to component-library readme (#18501) 2023-04-19 19:30:29 -07:00

Component Library

This folder contains design system components that are built 1:1 with the Figma DS Components UI kit and should be used where possible in all UI feature work.

Architecture

All components are built on top of the Box component and accept all Box component props

Layout

component-library components accept all utility props for layout

import { Text } from '../../component-library'

<Text marginBottom={4}>This text has a margin-bottom of 16px</Text>

Polymorphic as prop

component-library components accept a polymorphic as prop to change the root html element of a component

import { Text } from '../../component-library'

<ul>
<Text as="li">This renders as list item html element</Text>
</ul>

TypeScript

We are currently in the process of migrating all component-library components to TypeScript. Feel free to contribute by creating a PR against one of these issues

Support

If internal folks have any questions please reach out the design system team via the internal slack channel #metamask-design-system 💁

DS components figma file (internal)