Skip to content

Commit

Permalink
Add README, artwork and icon
Browse files Browse the repository at this point in the history
  • Loading branch information
mbrookes committed Oct 31, 2019
1 parent 51dc003 commit fbd167e
Show file tree
Hide file tree
Showing 7 changed files with 1,198 additions and 97 deletions.
58 changes: 58 additions & 0 deletions framer/Material-UI.framerfx/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Material-UI

This is the official resource for Material-UI React components in Framer.

## Supported components

The following components are currently supported:

- App bar
- Avatar
- Badge
- Bottom navigation
- Button
- Checkbox
- Chip
- Circular progress
- Floating action button (Fab)
- Icon (all 1100+ Material Icons in 5 variants)
- Icon button
- Linear progress
- List
- List item (with some layout issues)
- Media card
- Paper
- Radio
- Radio group
- Slider
- Snackbar content
- Switch
- Tabs
- Text field
- Theme (to globally set primary, secondary and error colors)
- Typography

## Usage

### Icons

Icons can be specified using either snake_case (as documented on material.io),
or PascalCase, as [documented in the Material-UI documentation](https://material-ui.com/components/material-icons/).
Simply type the icon name in the appropriate property control.

The icon theme can be chosen from the related select field.

### Children

Where a component accepts a variety of children (such as Avatar) these can be configured through Framer property controls.
If multiple options are supplied, they take the following priority:

- Local image
- Image URL
- Icon
- Text

## Resources

- [Material-UI documentation](https://material-ui.com/)
- [GitHub repo](https://github.com/mui-org/material-ui/tree/master/framer)
2 changes: 1 addition & 1 deletion framer/Material-UI.framerfx/code/MediaCard.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export class MediaCard extends React.Component<Props> {
title: 'Material Improvement',
subtitle: 'by Laura Philips',
body:
'Discover how Material-UI became the leading, the leading React Material Design component library.',
'Discover how Material-UI, the leading React Material Design component library, can help to improve your users\' experience.',
icon1: 'share',
icon2: 'more_vert',
};
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit fbd167e

Please sign in to comment.