1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-22 18:00:18 +01:00
metamask-extension/ui/helpers/constants/design-system.ts
Garrett Bear 3f27d018c4
Fix/buttonbase ts update (#20060)
* Migrate ButtonBase to TS

---------

Co-authored-by: Binij Shrestha <shresthabinij@gmail.com>
2023-07-25 09:05:15 -07:00

537 lines
14 KiB
TypeScript

/**
* A note about the existence of both singular and plural variable names here:
* When dealing with a literal property name, e.g. AlignItems, the constant
* should match the property. When detailing a collection of things, it should
* match the plural form of the thing. e.g. Color, TextVariant, Size
*/
export enum Color {
backgroundDefault = 'background-default',
backgroundAlternative = 'background-alternative',
textDefault = 'text-default',
textAlternative = 'text-alternative',
textMuted = 'text-muted',
iconDefault = 'icon-default',
iconAlternative = 'icon-alternative',
iconMuted = 'icon-muted',
borderDefault = 'border-default',
borderMuted = 'border-muted',
overlayDefault = 'overlay-default',
overlayInverse = 'overlay-inverse',
primaryDefault = 'primary-default',
primaryAlternative = 'primary-alternative',
primaryMuted = 'primary-muted',
primaryInverse = 'primary-inverse',
primaryDisabled = 'primary-disabled',
errorDefault = 'error-default',
errorAlternative = 'error-alternative',
errorMuted = 'error-muted',
errorInverse = 'error-inverse',
errorDisabled = 'error-disabled',
warningDefault = 'warning-default',
warningAlternative = 'warning-alternative',
warningMuted = 'warning-muted',
warningInverse = 'warning-inverse',
warningDisabled = 'warning-disabled',
successDefault = 'success-default',
successAlternative = 'success-alternative',
successMuted = 'success-muted',
successInverse = 'success-inverse',
successDisabled = 'success-disabled',
infoDefault = 'info-default',
infoAlternative = 'info-alternative',
infoMuted = 'info-muted',
infoInverse = 'info-inverse',
infoDisabled = 'info-disabled',
mainnet = 'mainnet',
goerli = 'goerli',
sepolia = 'sepolia',
lineaGoerli = 'linea-goerli',
lineaGoerliInverse = 'linea-goerli-inverse',
lineaMainnet = 'linea-mainnet',
lineaMainnetInverse = 'linea-mainnet-inverse',
transparent = 'transparent',
localhost = 'localhost',
inherit = 'inherit',
goerliInverse = 'goerli-inverse',
sepoliaInverse = 'sepolia-inverse',
}
export enum BackgroundColor {
backgroundDefault = 'background-default',
backgroundAlternative = 'background-alternative',
overlayDefault = 'overlay-default',
primaryDefault = 'primary-default',
primaryAlternative = 'primary-alternative',
primaryMuted = 'primary-muted',
errorDefault = 'error-default',
errorAlternative = 'error-alternative',
errorMuted = 'error-muted',
warningDefault = 'warning-default',
warningAlternative = 'warning-alternative',
warningMuted = 'warning-muted',
successDefault = 'success-default',
successAlternative = 'success-alternative',
successMuted = 'success-muted',
infoDefault = 'info-default',
infoAlternative = 'info-alternative',
infoMuted = 'info-muted',
mainnet = 'mainnet',
goerli = 'goerli',
sepolia = 'sepolia',
lineaGoerli = 'linea-goerli',
lineaMainnet = 'linea-mainnet',
transparent = 'transparent',
localhost = 'localhost',
}
export enum BorderColor {
borderDefault = 'border-default',
borderMuted = 'border-muted',
primaryDefault = 'primary-default',
primaryAlternative = 'primary-alternative',
primaryMuted = 'primary-muted',
errorDefault = 'error-default',
errorAlternative = 'error-alternative',
errorMuted = 'error-muted',
warningDefault = 'warning-default',
warningAlternative = 'warning-alternative',
warningMuted = 'warning-muted',
successDefault = 'success-default',
successAlternative = 'success-alternative',
successMuted = 'success-muted',
infoDefault = 'info-default',
infoAlternative = 'info-alternative',
infoMuted = 'info-muted',
mainnet = 'mainnet',
goerli = 'goerli',
sepolia = 'sepolia',
lineaGoerli = 'linea-goerli',
lineaMainnet = 'linea-mainnet',
transparent = 'transparent',
localhost = 'localhost',
backgroundDefault = 'background-default', // exception for border color when element is meant to look "cut out"
}
export enum TextColor {
textDefault = 'text-default',
textAlternative = 'text-alternative',
textMuted = 'text-muted',
overlayInverse = 'overlay-inverse',
primaryDefault = 'primary-default',
primaryInverse = 'primary-inverse',
errorDefault = 'error-default',
errorInverse = 'error-inverse',
successDefault = 'success-default',
successInverse = 'success-inverse',
warningDefault = 'warning-default',
warningInverse = 'warning-inverse',
infoDefault = 'info-default',
infoInverse = 'info-inverse',
inherit = 'inherit',
goerli = 'goerli',
sepolia = 'sepolia',
lineaGoerli = 'linea-goerli',
lineaGoerliInverse = 'linea-goerli-inverse',
lineaMainnet = 'linea-mainnet',
lineaMainnetInverse = 'linea-mainnet-inverse',
goerliInverse = 'goerli-inverse',
sepoliaInverse = 'sepolia-inverse',
transparent = 'transparent',
}
export enum IconColor {
iconDefault = 'icon-default',
iconAlternative = 'icon-alternative',
iconMuted = 'icon-muted',
overlayInverse = 'overlay-inverse',
primaryDefault = 'primary-default',
primaryInverse = 'primary-inverse',
errorDefault = 'error-default',
errorInverse = 'error-inverse',
successDefault = 'success-default',
successInverse = 'success-inverse',
warningDefault = 'warning-default',
warningInverse = 'warning-inverse',
infoDefault = 'info-default',
infoInverse = 'info-inverse',
inherit = 'inherit',
goerli = 'goerli',
sepolia = 'sepolia',
lineaGoerli = 'linea-goerli',
lineaGoerliInverse = 'linea-goerli-inverse',
lineaMainnet = 'linea-mainnet',
lineaMainnetInverse = 'linea-mainnet-inverse',
goerliInverse = 'goerli-inverse',
sepoliaInverse = 'sepolia-inverse',
transparent = 'transparent',
}
export enum TypographyVariant {
H1 = 'h1',
H2 = 'h2',
H3 = 'h3',
H4 = 'h4',
H5 = 'h5',
H6 = 'h6',
H7 = 'h7',
H8 = 'h8',
H9 = 'h9',
paragraph = 'p',
span = 'span',
}
export enum TextVariant {
displayMd = 'display-md',
headingLg = 'heading-lg',
headingMd = 'heading-md',
headingSm = 'heading-sm',
bodyLgMedium = 'body-lg-medium',
bodyMd = 'body-md',
bodyMdMedium = 'body-md-medium',
bodyMdBold = 'body-md-bold',
bodySm = 'body-sm',
bodySmMedium = 'body-sm-medium',
bodySmBold = 'body-sm-bold',
bodyXs = 'body-xs',
bodyXsMedium = 'body-xs-medium',
inherit = 'inherit',
}
export enum Size {
XXS = 'xxs',
XS = 'xs',
SM = 'sm',
MD = 'md',
LG = 'lg',
XL = 'xl',
inherit = 'inherit', // Used for Text, Icon, and Button components to inherit the parent elements font-size
auto = 'auto',
}
export enum BorderStyle {
dashed = 'dashed',
solid = 'solid',
dotted = 'dotted',
double = 'double',
none = 'none',
}
export enum BorderRadius {
/**
* 2px
*/
XS = 'xs',
/**
* 4px
*/
SM = 'sm',
/**
* 6px
*/
MD = 'md',
/**
* 8px
*/
LG = 'lg',
/**
* 12px
*/
XL = 'xl',
/**
* 0
*/
none = 'none',
/**
* 9999px
*/
pill = 'pill',
/**
* 50%
*/
full = 'full',
}
// NOTE: The name of this enum is plural due to the name of property in css is `align-items`,
// which is for aligning all items not one
export enum AlignItems {
flexStart = 'flex-start',
flexEnd = 'flex-end',
center = 'center',
baseline = 'baseline',
stretch = 'stretch',
}
export enum JustifyContent {
flexStart = 'flex-start',
flexEnd = 'flex-end',
center = 'center',
spaceAround = 'space-around',
spaceBetween = 'space-between',
spaceEvenly = 'space-evenly',
}
export enum FlexDirection {
Row = 'row',
RowReverse = 'row-reverse',
Column = 'column',
ColumnReverse = 'column-reverse',
}
/**
* @deprecated `FLEX_DIRECTION` const has been deprecated in favor of the `FlexDirection` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `FLEX_DIRECTION` with `FlexDirection` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const FLEX_DIRECTION = {
ROW: 'row',
ROW_REVERSE: 'row-reverse',
COLUMN: 'column',
COLUMN_REVERSE: 'column-reverse',
};
export enum FlexWrap {
Wrap = 'wrap',
WrapReverse = 'wrap-reverse',
NoWrap = 'nowrap',
}
/**
* @deprecated `FLEX_WRAP` const has been deprecated in favor of the `FlexWrap` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `FLEX_WRAP` with `FlexWrap` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const FLEX_WRAP = {
WRAP: 'wrap',
WRAP_REVERSE: 'wrap-reverse',
NO_WRAP: 'nowrap',
};
export enum Display {
Block = 'block',
Flex = 'flex',
Grid = 'grid',
InlineBlock = 'inline-block',
Inline = 'inline',
InlineFlex = 'inline-flex',
InlineGrid = 'inline-grid',
ListItem = 'list-item',
None = 'none',
}
/**
* @deprecated `DISPLAY` const has been deprecated in favor of the `Display` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `DISPLAY` with `Display` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const DISPLAY = {
BLOCK: 'block',
FLEX: 'flex',
GRID: 'grid',
INLINE_BLOCK: 'inline-block',
INLINE: 'inline',
INLINE_FLEX: 'inline-flex',
INLINE_GRID: 'inline-grid',
LIST_ITEM: 'list-item',
NONE: 'none',
};
/**
* @deprecated `FRACTIONS` const has been deprecated in favor of the `BlockSize` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `FRACTIONS` with `BlockSize` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const FRACTIONS = {
HALF: '1/2',
ONE_THIRD: '1/3',
TWO_THIRDS: '2/3',
ONE_FOURTH: '1/4',
TWO_FOURTHS: '2/4',
THREE_FOURTHS: '3/4',
ONE_FIFTH: '1/5',
TWO_FIFTHS: '2/5',
THREE_FIFTHS: '3/5',
FOUR_FIFTHS: '4/5',
ONE_SIXTH: '1/6',
TWO_SIXTHS: '2/6',
THREE_SIXTHS: '3/6',
FOUR_SIXTHS: '4/6',
FIVE_SIXTHS: '5/6',
ONE_TWELFTH: '1/12',
TWO_TWELFTHS: '2/12',
THREE_TWELFTHS: '3/12',
FOUR_TWELFTHS: '4/12',
FIVE_TWELFTHS: '5/12',
SIX_TWELFTHS: '6/12',
SEVEN_TWELFTHS: '7/12',
EIGHT_TWELFTHS: '8/12',
NINE_TWELFTHS: '9/12',
TEN_TWELFTHS: '10/12',
ELEVEN_TWELFTHS: '11/12',
};
export enum BlockSize {
Half = '1/2',
OneThird = '1/3',
TwoThirds = '2/3',
OneFourth = '1/4',
TwoFourths = '2/4',
ThreeFourths = '3/4',
OneFifth = '1/5',
TwoFifths = '2/5',
ThreeFifths = '3/5',
FourFifths = '4/5',
OneSixth = '1/6',
TwoSixths = '2/6',
ThreeSixths = '3/6',
FourSixths = '4/6',
FiveSixths = '5/6',
OneTwelfth = '1/12',
TwoTwelfths = '2/12',
ThreeTwelfths = '3/12',
FourTwelfths = '4/12',
FiveTwelfths = '5/12',
SixTwelfths = '6/12',
SevenTwelfths = '7/12',
EightTwelfths = '8/12',
NineTwelfths = '9/12',
TenTwelfths = '10/12',
ElevenTwelfths = '11/12',
Screen = 'screen',
Max = 'max',
Min = 'min',
Full = 'full',
}
/**
* @deprecated `BLOCK_SIZES` const has been deprecated in favor of the `BlockSize` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `BLOCK_SIZES` with `BlockSize` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const BLOCK_SIZES = {
...FRACTIONS,
SCREEN: 'screen',
MAX: 'max',
MIN: 'min',
FULL: 'full',
};
export enum TextAlign {
Left = 'left',
Center = 'center',
Right = 'right',
Justify = 'justify',
End = 'end',
Start = 'start',
}
/**
* @deprecated `TEXT_ALIGN` const has been deprecated in favor of the `TextAlign` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `TEXT_ALIGN` with `TextAlign` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const TEXT_ALIGN = {
LEFT: 'left',
CENTER: 'center',
RIGHT: 'right',
JUSTIFY: 'justify',
END: 'end',
START: 'start',
};
export enum TextTransform {
// eslint-disable-next-line @typescript-eslint/no-shadow
Uppercase = 'uppercase',
// eslint-disable-next-line @typescript-eslint/no-shadow
Lowercase = 'lowercase',
// eslint-disable-next-line @typescript-eslint/no-shadow
Capitalize = 'capitalize',
}
/**
* @deprecated `TEXT_TRANSFORM` const has been deprecated in favor of the `TextTransform` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `TEXT_TRANSFORM` with `TextTransform` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const TEXT_TRANSFORM = {
UPPERCASE: 'uppercase',
LOWERCASE: 'lowercase',
CAPITALIZE: 'capitalize',
};
export enum FontWeight {
Bold = 'bold',
Medium = 'medium',
Normal = 'normal',
}
/**
* @deprecated `FONT_WEIGHT` const has been deprecated in favor of the `FontWeight` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `FONT_WEIGHT` with `FontWeight` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const FONT_WEIGHT = {
BOLD: 'bold',
MEDIUM: 'medium',
NORMAL: 'normal',
};
export enum OverflowWrap {
BreakWord = 'break-word',
Anywhere = 'anywhere',
Normal = 'normal',
}
/**
* @deprecated `OVERFLOW_WRAP` const has been deprecated in favor of the `OverflowWrap` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `OVERFLOW_WRAP` with `OverflowWrap` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const OVERFLOW_WRAP = {
BREAK_WORD: 'break-word',
ANYWHERE: 'anywhere',
NORMAL: 'normal',
};
export enum FontStyle {
Italic = 'italic',
Normal = 'normal',
}
/**
* @deprecated `FONT_STYLE` const has been deprecated in favor of the `FontStyle` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `FONT_STYLE` with `FontStyle` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const FONT_STYLE = {
ITALIC: 'italic',
NORMAL: 'normal',
};
export enum Severity {
Danger = 'danger',
Warning = 'warning',
Info = 'info',
Success = 'success',
}
/**
* @deprecated `SEVERITIES` const has been deprecated in favor of the `Severity` enum which can still be imported from `ui/helpers/constants/design-system.ts`
*
* Help to replace `SEVERITIES` with `FontStyle` by submitting PRs against https://github.com/MetaMask/metamask-extension/issues/18714
*/
export const SEVERITIES = {
DANGER: 'danger',
WARNING: 'warning',
INFO: 'info',
SUCCESS: 'success',
};
export const BREAKPOINTS = ['base', 'sm', 'md', 'lg'];