Skip to content

Style property documentation #2083

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

Merged
merged 1 commit into from
Nov 8, 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: 1 addition & 1 deletion docs/src/app/components/pages/components/app-bar.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ export default class AppBarPage extends React.Component {
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the app bars\'s root element.',
desc: 'Override the inline-styles of the app bar\'s root element.',
},
{
name: 'showMenuIconButton',
Expand Down
6 changes: 6 additions & 0 deletions docs/src/app/components/pages/components/cards.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ export default class CardPage extends React.Component {
'and CardActions implement showExpandableButton. Any child component of Card can implements ' +
'showExpandableButton or forwards the property to a child component supporting it.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the card\'s root element.',
},
],
},
{
Expand Down
6 changes: 6 additions & 0 deletions docs/src/app/components/pages/components/dialog.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ export default class DialogPage extends React.Component {
header: 'optional',
desc: 'The ref of the action to focus on when the dialog is displayed.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the dialog\'s root element.',
},
{
name: 'bodyStyle',
type: 'object',
Expand Down
12 changes: 12 additions & 0 deletions docs/src/app/components/pages/components/grid-list.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ class GridListPage extends React.Component {
header: 'optional',
desc: 'Number of px for one cell height. Defaults to 180.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the grid list\'s root element.',
},
],
},
{
Expand Down Expand Up @@ -96,6 +102,12 @@ class GridListPage extends React.Component {
header: 'optional',
desc: 'Height of the tile in number of grid cells. Defaults to 1.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the grid tile\'s root element.',
},
{
name: 'rootClass',
type: 'string|ReactComponent',
Expand Down
6 changes: 6 additions & 0 deletions docs/src/app/components/pages/components/icon-menus.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ export default class IconMenus extends React.Component {
header: 'default: false',
desc: 'Indicates if the menu should render with compact desktop styles.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the icon menu\'s root element.',
},
{
name: 'iconStyle',
type: 'object',
Expand Down
12 changes: 12 additions & 0 deletions docs/src/app/components/pages/components/icons.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ export default class FontIconPage extends React.Component {
header: 'optional',
desc: 'This is the icon color when the mouse hovers over the icon.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the font icon\'s root element.',
},
],
},
{
Expand All @@ -93,6 +99,12 @@ export default class FontIconPage extends React.Component {
header: 'optional',
desc: 'This is the icon color when the mouse hovers over the icon.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the svg icon\'s root element.',
},
],
},
];
Expand Down
12 changes: 12 additions & 0 deletions docs/src/app/components/pages/components/lists.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ export default class ListsPage extends React.Component {
header: 'default: false',
desc: 'If true, the subheader will be indented by 72px.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the list\'s root element.',
},
{
name: 'subheader',
type: 'node',
Expand Down Expand Up @@ -170,6 +176,12 @@ export default class ListsPage extends React.Component {
header: 'default: 1',
desc: 'Can be 1 or 2. This is the number of secondary text lines before ellipsis will show.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the list item\'s root element.',
},
],
},
{
Expand Down
12 changes: 12 additions & 0 deletions docs/src/app/components/pages/components/menus.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,12 @@ export default class MenusPage extends React.Component {
header: 'default: false',
desc: 'Indicates if the menu should render with compact desktop styles.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the menu\'s root element.',
},
{
name: 'listStyle',
type: 'object',
Expand Down Expand Up @@ -114,6 +120,12 @@ export default class MenusPage extends React.Component {
header: 'default: false',
desc: 'Disables a menu item.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the menu item\'s root element.',
},
{
name: 'innerDivStyle',
type: 'object',
Expand Down
6 changes: 6 additions & 0 deletions docs/src/app/components/pages/components/progress.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ let ProgressPage = React.createClass({
header: 'default: 1',
desc: 'The size of the progress.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the progress\'s root element.',
},
],
},
];
Expand Down
42 changes: 42 additions & 0 deletions docs/src/app/components/pages/components/table.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ export default class TablePage extends React.Component {
desc: 'If true, table rows can be selected. If multiple row selection is desired, enable multiSelectable. ' +
'The default value is true.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table\'s root element.',
},
],
},
{
Expand Down Expand Up @@ -120,6 +126,12 @@ export default class TablePage extends React.Component {
desc: 'If set to true the select all checkbox will be programmatically checked and will not trigger the select ' +
'all event.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table header\'s root element.',
},
],
},
{
Expand Down Expand Up @@ -177,6 +189,12 @@ export default class TablePage extends React.Component {
header: 'optional',
desc: 'If true, every other table row starting with the first row will be striped. The default value is false.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table body\'s root element.',
},
],
},
{
Expand All @@ -190,6 +208,12 @@ export default class TablePage extends React.Component {
'is true, this property will not influence the number of columns. This is mainly useful for "super header" ' +
'rows so that the checkbox column does not create an offset that needs to be accounted for manually.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table footer\'s root element.',
},
],
},
{
Expand Down Expand Up @@ -232,6 +256,12 @@ export default class TablePage extends React.Component {
header: 'default: false',
desc: 'Indicates whether or not the row is striped.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table row\'s root element.',
},
],
},
{
Expand All @@ -255,6 +285,12 @@ export default class TablePage extends React.Component {
header: 'optional',
desc: 'Additional styling that can be applied to the tooltip.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table header column\'s root element.',
},
],
},
{
Expand All @@ -272,6 +308,12 @@ export default class TablePage extends React.Component {
header: 'default: false',
desc: 'If true, this column responds to hover events.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the table row column\'s root element.',
},
],
},
{
Expand Down
18 changes: 18 additions & 0 deletions docs/src/app/components/pages/components/toolbars.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@ export default class ToolbarPage extends React.Component {
header: 'optional',
desc: 'Optional pull "left" or "right"',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the toolbar group\'s root element.',
},
],
},
{
Expand All @@ -53,6 +59,12 @@ export default class ToolbarPage extends React.Component {
desc: 'A vertical bar used to separate groups of components. It ' +
'is used to easily organize components.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the toolbar separator\'s root element.',
},
],
},
{
Expand All @@ -68,6 +80,12 @@ export default class ToolbarPage extends React.Component {
header: 'optional',
desc: 'The text to be displayed for the element.',
},
{
name: 'style',
type: 'object',
header: 'optional',
desc: 'Override the inline-styles of the toolbar title\'s root element.',
},
],
},
];
Expand Down
1 change: 1 addition & 0 deletions src/card/card-actions.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ const CardActions = React.createClass({
expandable: React.PropTypes.bool,
actAsExpander: React.PropTypes.bool,
showExpandableButton: React.PropTypes.bool,
style: React.PropTypes.object,
},

render() {
Expand Down
1 change: 1 addition & 0 deletions src/card/card-expandable.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ const CardExpandable = React.createClass({
propTypes: {
onExpanding: React.PropTypes.func.isRequired,
expanded: React.PropTypes.bool,
style: React.PropTypes.object,
},

//for passing default theme context to children
Expand Down
1 change: 1 addition & 0 deletions src/card/card-header.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ const CardHeader = React.createClass({
title: React.PropTypes.node,
titleColor: React.PropTypes.string,
titleStyle: React.PropTypes.object,
style: React.PropTypes.object,
subtitle: React.PropTypes.node,
subtitleColor: React.PropTypes.string,
subtitleStyle: React.PropTypes.object,
Expand Down
1 change: 1 addition & 0 deletions src/card/card-title.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const CardTitle = React.createClass({
title: React.PropTypes.node,
titleColor: React.PropTypes.string,
titleStyle: React.PropTypes.object,
style: React.PropTypes.object,
subtitle: React.PropTypes.node,
subtitleColor: React.PropTypes.string,
subtitleStyle: React.PropTypes.object,
Expand Down
1 change: 1 addition & 0 deletions src/circular-progress.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ const CircularProgress = React.createClass({
max: React.PropTypes.number,
size: React.PropTypes.number,
color: React.PropTypes.string,
style: React.PropTypes.object,
innerStyle: React.PropTypes.object,
},

Expand Down
4 changes: 4 additions & 0 deletions src/clearfix.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ const ClearFix = React.createClass({
muiTheme: React.PropTypes.object,
},

propTypes: {
style: React.PropTypes.object,
},

//for passing default theme context to children
childContextTypes: {
muiTheme: React.PropTypes.object,
Expand Down
1 change: 1 addition & 0 deletions src/date-picker/date-display.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ const DateDisplay = React.createClass({
disableYearSelection: React.PropTypes.bool,
monthDaySelected: React.PropTypes.bool,
selectedDate: React.PropTypes.object.isRequired,
style: React.PropTypes.object,
weekCount: React.PropTypes.number,
},

Expand Down
1 change: 1 addition & 0 deletions src/date-picker/date-picker-dialog.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ const DatePickerDialog = React.createClass({
onClickAway: React.PropTypes.func,
onDismiss: React.PropTypes.func,
onShow: React.PropTypes.func,
style: React.PropTypes.object,
shouldDisableDate: React.PropTypes.func,
showYearSelector: React.PropTypes.bool,
},
Expand Down
1 change: 1 addition & 0 deletions src/dialog.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ let Dialog = React.createClass({
openImmediately: React.PropTypes.bool,
onClickAway: React.PropTypes.func,
repositionOnUpdate: React.PropTypes.bool,
style: React.PropTypes.object,
title: React.PropTypes.node,
defaultIsOpen: React.PropTypes.bool,
isOpen: React.PropTypes.bool,
Expand Down
1 change: 1 addition & 0 deletions src/drop-down-icon.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ const DropDownIcon = React.createClass({
iconStyle: React.PropTypes.object,
iconClassName: React.PropTypes.string,
iconLigature: React.PropTypes.string,
style: React.PropTypes.object,
},

getInitialState() {
Expand Down
1 change: 1 addition & 0 deletions src/drop-down-menu.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ const DropDownMenu = React.createClass({
labelStyle:React.PropTypes.object,
selectedIndex: React.PropTypes.number,
openImmediately: React.PropTypes.bool,
style: React.PropTypes.object,
},

getDefaultProps() {
Expand Down
1 change: 1 addition & 0 deletions src/enhanced-button.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ const EnhancedButton = React.createClass({
onKeyUp: React.PropTypes.func,
onTouchTap: React.PropTypes.func,
tabIndex: React.PropTypes.number,
style: React.PropTypes.object,
},

getDefaultProps() {
Expand Down
Loading