Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Material-UI cheat sheet #368

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions frontend/material-ui.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
##############################################################################
# Material-UI
# Material-UI: React components for modern web design.
# WEBSITE: https://mui.com/material-ui/
# DOCUMENTATION: https://mui.com/material-ui/getting-started/
##############################################################################


##############################################################################
# CORE COMPONENTS
##############################################################################

Button - variant: Style of the button, e.g., "contained" or "outlined".
color: Color scheme, e.g., "primary", "secondary".

Typography - variant: Text style, e.g., "h1", "body1".


Grid - container: Marks an element as a grid container.
item: Marks an element as a grid item.


Icon- Use specific icon names or custom SVG.


##############################################################################
# FORM COMPONENTS
##############################################################################

TextField - label: Label for the input field.
variant: Input style, e.g., "filled" or "outlined".

Checkbox/Radio - color: Color scheme, e.g., "primary", "secondary".

Select - variant: Select style, e.g., "filled" or "outlined".

Slider - value: Current value of the slider.


##############################################################################
# LAYOUT COMPONENTS
##############################################################################

AppBar/Toolbar - position: Positioning, e.g., "fixed" or "static".

Drawer - anchor: Side to anchor, e.g., "left" or "right".

Card - variant: Card style, e.g., "outlined" or "elevation".

Stepper - alternativeLabel: Display step labels.


##############################################################################
# NAVIGATION COMPONENTS
##############################################################################

Tabs/Breadcrumbs - value: Current active tab.
aria-label: Accessible label.

Menu/IconButton - edge: Edge to anchor, e.g., "start" or "end".


##############################################################################
# FEEDBACK COMPONENTS
##############################################################################

Snackbar/Alert - severity: Severity, e.g., "success", "error".

Progress - color: Color scheme, e.g., "primary", "secondary".

Tooltip - title: Tooltip content.


##############################################################################
# DIALOGS/MODALS
##############################################################################

Dialog/Modal - open: Control visibility.


##############################################################################
# STYLING
##############################################################################


makeStyles/withStyles - Define and apply custom styles.

ThemeProvider - Apply a custom theme.


##############################################################################
# DATA DISPLAY
##############################################################################

Avatar/Badge - color: Color scheme, e.g., "primary", "secondary".

Chip - color: Color scheme, e.g., "primary", "secondary".

Table - size: Size, e.g., "small", "medium".


##############################################################################
# UTILITY COMPONENTS
##############################################################################

Popover - anchorEl: Element to anchor to.

ClickAwayListener - Handle clicks outside.

Hidden - Media query breakpoints, e.g., mdDown, lgUp.

CssBaseline - Apply basic styling.


##############################################################################
# TRANSITIONS/ANIMATIONS
##############################################################################

Collapse/Fade/Grow/Slide - Transition-specific attributes.


##############################################################################
# THEMES
##############################################################################

Custom Theme/ThemeProvider - Define and apply themes.


##############################################################################
# HOOKS
##############################################################################

useMediaQuery/useScrollTrigger - Responsive design.
Media query and scroll control.

useTheme - Access theme properties.


##############################################################################
# CUSTOMIZATION
##############################################################################

Customize Theme/withStyles - Override and customize styles.