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 Badge component. #2045

Merged
merged 1 commit into from
Nov 9, 2015
Merged
Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions docs/src/app/app-routes.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ const InlineStyles = require('./components/pages/customization/inline-styles');
const Components = require('./components/pages/components');
const AppBar = require('./components/pages/components/app-bar');
const Avatars = require('./components/pages/components/avatars');
const Badge = require('./components/pages/components/badge');
const Buttons = require('./components/pages/components/buttons');
const Cards = require('./components/pages/components/cards');
const DatePicker = require('./components/pages/components/date-picker');
Expand Down Expand Up @@ -77,6 +78,7 @@ const AppRoutes = (
<Route path="components" component={Components}>
<Route path="appbar" component={AppBar} />
<Route path="avatars" component={Avatars} />
<Route path="badge" component={Badge} />
<Route path="buttons" component={Buttons} />
<Route path="cards" component={Cards} />
<Route path="date-picker" component={DatePicker} />
Expand Down
1 change: 1 addition & 0 deletions docs/src/app/components/pages/components.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ export default class Components extends React.Component {
let menuItems = [
{ route: '/components/appbar', text: 'AppBar'},
{ route: '/components/avatars', text: 'Avatars'},
{ route: '/components/badge', text: 'Badge'},
{ route: '/components/buttons', text: 'Buttons'},
{ route: '/components/cards', text: 'Cards'},
{ route: '/components/date-picker', text: 'Date Picker'},
Expand Down
88 changes: 88 additions & 0 deletions docs/src/app/components/pages/components/badge.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
let React = require('react');
let { FontIcon, IconButton, Badge } = require('material-ui');
let ComponentDoc = require('../../component-doc');
let Code = require('badge-code');
let CodeExample = require('../../code-example/code-example');
const NotificationsIcon = require('svg-icons/social/notifications');
const ShoppingCartIcon = require('svg-icons/action/shopping-cart');
const FolderIcon = require('svg-icons/file/folder-open');
const UploadIcon = require('svg-icons/file/cloud-upload');

export default class BadgePage extends React.Component {
constructor(props) {
super(props);

this.desc = 'This component generates a small badge to the top-right of it\'s child(ren)';

this.componentInfo = [
{
name: 'Props',
infoArray: [
{
name: 'badgeContent',
type: 'node',
header: 'required',
desc: 'This is the content rendered within the badge.',
},
{
name: 'primary',
type: 'bool',
header: 'default: false',
desc: 'If true, the badge will use the primary badge colors.',
},
{
name: 'secondary',
type: 'bool',
header: 'default: false',
desc: 'If true, the badge will use the secondary badge colors.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the root element.',
},
{
name: 'badgeStyle',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the badge element.',
},
],
},
];
}

render() {
return (
<ComponentDoc
name="Badge"
desc={this.desc}
componentInfo={this.componentInfo}>
<CodeExample code={Code}>

<Badge badgeContent={4} primary={true}>
<NotificationsIcon />
</Badge>

<Badge badgeContent={10} secondary={true} badgeStyle={{top:12, right:12}}>
<IconButton tooltip="Go To Cart">
<ShoppingCartIcon/>
</IconButton>
</Badge>

<Badge backgroundColor="#d8d8d8"
badgeContent={<IconButton tooltip="Backup"><UploadIcon/></IconButton>}>
<FolderIcon />
</Badge>

<Badge badgeContent="&copy;" badgeStyle={{fontSize:20}}>
<h3>Company Name</h3>
</Badge>

</CodeExample>
</ComponentDoc>
);
}

}
19 changes: 19 additions & 0 deletions docs/src/app/components/raw-code/badge-code.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<Badge badgeContent={4} primary={true}>
<NotificationsIcon />
</Badge>

//override badgeStyle to account for padding of child element
<Badge badgeContent={10} secondary={true} badgeStyle={{top:12, right:12}}>
<IconButton tooltip="Go To Cart">
<ShoppingCartIcon/>
</IconButton>
</Badge>

<Badge backgroundColor="#d8d8d8"
badgeContent={<IconButton tooltip="Backup"><UploadIcon/></IconButton>}>
<FolderIcon />
</Badge>

<Badge badgeContent="&copy;" badgeStyle={{fontSize:20}}>
<h3>Company Name</h3>
</Badge>
106 changes: 106 additions & 0 deletions src/badge.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
const React = require('react');
const Typography = require('./styles/typography');
const DefaultRawTheme = require('./styles/raw-themes/light-raw-theme');
const ThemeManager = require('./styles/theme-manager');
const StylePropable = require('./mixins/style-propable');

// Badge
export default React.createClass({
displayName: 'Badge',
mixins: [StylePropable],
contextTypes: {
muiTheme: React.PropTypes.object,
},
//for passing default theme context to children
childContextTypes: {
muiTheme: React.PropTypes.object,
},
getChildContext () {
return {
muiTheme: this.state.muiTheme,
};
},
propTypes: {
className: React.PropTypes.string,
badgeContent: React.PropTypes.node.isRequired,
primary: React.PropTypes.bool,
secondary: React.PropTypes.bool,
style: React.PropTypes.object,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add the default value with getDefaultProps?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added getDefaultProps cfd972d

badgeStyle: React.PropTypes.object,
},
getInitialState() {
return {
muiTheme: this.context.muiTheme ? this.context.muiTheme : ThemeManager.getMuiTheme(DefaultRawTheme),
};
},
getDefaultProps() {
return {
className: '',
primary: false,
secondary: false,
style: {},
badgeStyle: {},
};
},
componentWillReceiveProps(nextProps, nextContext) {
let newMuiTheme = nextContext.muiTheme ? nextContext.muiTheme : this.state.muiTheme;
this.setState({
muiTheme: newMuiTheme,
});
},
getStyles() {
const theme = this.state.muiTheme.badge;

const badgeBackgroundColor = this.props.primary
? theme.primaryColor
: this.props.secondary
? theme.secondaryColor
: theme.color;

const badgeTextColor = this.props.primary
? theme.primaryTextColor
: this.props.secondary
? theme.secondaryTextColor
: theme.textColor;

const radius = 12;
const radius2x = Math.floor(2*radius);

return {
root: {
position: 'relative',
display: 'inline-block',
padding: [radius2x+'px', radius2x+'px', radius+'px', radius+'px'].join(' '),
},
badge: {
display: 'flex',
flexDirection: 'row',
flexWrap: 'wrap',
justifyContent: 'center',
alignContent: 'center',
alignItems: 'center',
position: 'absolute',
top: 0,
right: 0,
fontWeight: Typography.fontWeightMedium,
fontSize: radius,
width: radius2x,
height: radius2x,
borderRadius: '50%',
backgroundColor: badgeBackgroundColor,
color: badgeTextColor,
},
};
},
render() {
const styles = this.getStyles();
return (
<div style={this.prepareStyles(styles.root, this.props.style)} className={this.props.className}>
{this.props.children}
<span style={this.prepareStyles(styles.badge, this.props.badgeStyle)}>
{this.props.badgeContent}
</span>
</div>
);
},
});
1 change: 1 addition & 0 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ module.exports = {
AppBar: require('./app-bar'),
AppCanvas: require('./app-canvas'),
Avatar: require('./avatar'),
Badge: require('./badge'),
BeforeAfterWrapper: require('./before-after-wrapper'),
Card: require('./card/card'),
CardActions: require('./card/card-actions'),
Expand Down
8 changes: 8 additions & 0 deletions src/styles/theme-manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@ module.exports = {
avatar: {
borderColor: 'rgba(0, 0, 0, 0.08)',
},
badge: {
color: rawTheme.palette.alternateTextColor,
textColor: rawTheme.palette.textColor,
primaryColor: rawTheme.palette.accent1Color,
primaryTextColor: rawTheme.palette.alternateTextColor,
secondaryColor: rawTheme.palette.primary1Color,
secondaryTextColor: rawTheme.palette.alternateTextColor,
},
button: {
height: 36,
minWidth: 88,
Expand Down