Merge pull request mui#2083 from subjectix/dialog-style-prop

[doc] Add style property
tyfoo · Nov 8, 2015 · c78b437 · c78b437
2 parents df5f6ed + 0dc2e4a
commit c78b437
Show file tree

Hide file tree

Showing 68 changed files with 203 additions and 4 deletions.
diff --git a/docs/src/app/components/pages/components/app-bar.jsx b/docs/src/app/components/pages/components/app-bar.jsx
@@ -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',

diff --git a/docs/src/app/components/pages/components/cards.jsx b/docs/src/app/components/pages/components/cards.jsx
@@ -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.',
+          },
         ],
       },
       {

diff --git a/docs/src/app/components/pages/components/dialog.jsx b/docs/src/app/components/pages/components/dialog.jsx
@@ -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',

diff --git a/docs/src/app/components/pages/components/grid-list.jsx b/docs/src/app/components/pages/components/grid-list.jsx
@@ -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.',
+          },
         ],
       },
       {
@@ -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',

diff --git a/docs/src/app/components/pages/components/icon-menus.jsx b/docs/src/app/components/pages/components/icon-menus.jsx
@@ -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',

diff --git a/docs/src/app/components/pages/components/icons.jsx b/docs/src/app/components/pages/components/icons.jsx
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
     ];

diff --git a/docs/src/app/components/pages/components/lists.jsx b/docs/src/app/components/pages/components/lists.jsx
@@ -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',
@@ -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.',
+          },
         ],
       },
       {

diff --git a/docs/src/app/components/pages/components/menus.jsx b/docs/src/app/components/pages/components/menus.jsx
@@ -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',
@@ -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',

diff --git a/docs/src/app/components/pages/components/progress.jsx b/docs/src/app/components/pages/components/progress.jsx
@@ -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.',
+          },
         ],
       },
     ];

diff --git a/docs/src/app/components/pages/components/table.jsx b/docs/src/app/components/pages/components/table.jsx
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {

diff --git a/docs/src/app/components/pages/components/toolbars.jsx b/docs/src/app/components/pages/components/toolbars.jsx
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
       {
@@ -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.',
+          },
         ],
       },
     ];

diff --git a/src/card/card-actions.jsx b/src/card/card-actions.jsx
@@ -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() {

diff --git a/src/card/card-expandable.jsx b/src/card/card-expandable.jsx
@@ -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

diff --git a/src/card/card-header.jsx b/src/card/card-header.jsx
@@ -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,

diff --git a/src/card/card-title.jsx b/src/card/card-title.jsx
@@ -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,

diff --git a/src/circular-progress.jsx b/src/circular-progress.jsx
@@ -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,
   },
 

diff --git a/src/clearfix.jsx b/src/clearfix.jsx
@@ -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,

diff --git a/src/date-picker/date-display.jsx b/src/date-picker/date-display.jsx
@@ -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,
   },
 

diff --git a/src/date-picker/date-picker-dialog.jsx b/src/date-picker/date-picker-dialog.jsx
@@ -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,
   },

diff --git a/src/dialog.jsx b/src/dialog.jsx
@@ -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,

diff --git a/src/drop-down-icon.jsx b/src/drop-down-icon.jsx
@@ -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() {

diff --git a/src/drop-down-menu.jsx b/src/drop-down-menu.jsx
@@ -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() {

diff --git a/src/enhanced-button.jsx b/src/enhanced-button.jsx
@@ -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() {