vitalif
/
react-toolbox
1
0
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity

Update TS definition file to work properly with TypeScript >= 1.8, README blurb

old
Robert Parker 2016-02-03 16:31:26 -08:00
parent 3354d173c2
commit ac6834f1e9
2 changed files with 83 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -92,6 +92,8 @@ If you browse the resulting markup you will see *data attributes* like `data-rol
A TypeScript definition file `react-toolbox.d.ts` is available. It is referenced in `package.json` and should be picked up by the TypeScript compiler when importing from the npm package. A TypeScript definition file `react-toolbox.d.ts` is available. It is referenced in `package.json` and should be picked up by the TypeScript compiler when importing from the npm package.
Note that to comply with the typings requirement, a triple-slash reference to `react.d.ts` is *NOT included*. You will need to reference [react.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/react/react.d.ts) somewhere in your project.
## Authors and Contributors ## Authors and Contributors
The project is being initially developed and maintained by [Javier Velasco](http://javivelasco.com) and [Javier Jiménez](http://soyjavi.com) and the [contribution scene](https://github.com/react-toolbox/react-toolbox/graphs/contributors) is just getting warm. We want to create reference components so any contribution is very welcome. The project is being initially developed and maintained by [Javier Velasco](http://javivelasco.com) and [Javier Jiménez](http://soyjavi.com) and the [contribution scene](https://github.com/react-toolbox/react-toolbox/graphs/contributors) is just getting warm. We want to create reference components so any contribution is very welcome.

148
react-toolbox.d.ts vendored
View File

@ -1,7 +1,11 @@
// Type definitions for react-toolbox 0.14.0 // Type definitions for react-toolbox 0.14.1
// Project: http://react-toolbox.com/ // Project: http://react-toolbox.com/
// Definitions by: @xogeny (Michael M. Tiller), @hsrobflavorus (Robert Parker) // Definitions by: @xogeny (Michael M. Tiller), @hsrobflavorus (Robert Parker)
/* CHANGES /* CHANGES
* 02/03/2016:
* Fixed for TypeScript 1.8.0 stricter var declaration requirements (move `declare var ...` inside each individual module).
* Removed triple-slash reference to React to fix npm install compatibility (you'll need to make sure you're referencing react.d.ts somewhere in your project!).
* Hopefully fixed the default exports where applicable
* 01/13/2016: Minor changes, add a few missing props, add IconButton to react-toolbox/lib/button * 01/13/2016: Minor changes, add a few missing props, add IconButton to react-toolbox/lib/button
* 12/21/2015: Fix "import * as Input from 'react-toolbox/lib/input'" style imports, which now correctly import only the necessary component(s). * 12/21/2015: Fix "import * as Input from 'react-toolbox/lib/input'" style imports, which now correctly import only the necessary component(s).
* NOTE that you must use "import * as {Component Name}" not just "import {Component Name}" for this to work. * NOTE that you must use "import * as {Component Name}" not just "import {Component Name}" for this to work.
@ -17,7 +21,6 @@
MISSING COMPONENTS (Contributions welcome) MISSING COMPONENTS (Contributions welcome)
* Ripple HOC * Ripple HOC
*/ */
///<reference path='../react/react.d.ts' />
declare namespace __RT { declare namespace __RT {
import React = __React; import React = __React;
@ -388,7 +391,7 @@ declare namespace __RT {
export class Checkbox extends React.Component<CheckboxProps, {}> { export class Checkbox extends React.Component<CheckboxProps, {}> {
render(): React.DOMElement<any>; render(): React.DOMElement<any>;
} }
export interface DatePickerProps extends Changeable<Date> { export interface DatePickerProps extends Props, Changeable<Date> {
/** /**
* Date object with the maximum selectable date. * Date object with the maximum selectable date.
*/ */
@ -503,10 +506,18 @@ declare namespace __RT {
* Callback function that is fired when components is focused. * Callback function that is fired when components is focused.
*/ */
onFocus?: Function, onFocus?: Function,
/**
* Callback function that is fired when a key is pressed down.
*/
onKeyDown?: Function,
/** /**
* Callback function that is fired when a key is pressed. * Callback function that is fired when a key is pressed.
*/ */
onKeyPress?: Function, onKeyPress?: Function,
/**
* Callback function that is fired when a key is released.
*/
onKeyUp?: Function,
/** /**
* If true, the html input has a required value. * If true, the html input has a required value.
* @default false * @default false
@ -993,20 +1004,16 @@ declare namespace __RT {
class Tab extends React.Component<TabProps, {}> { class Tab extends React.Component<TabProps, {}> {
render(): React.DOMElement<any>; render(): React.DOMElement<any>;
} }
interface TimePickerProps extends Props { interface TimePickerProps extends Props, Changeable<Date> {
/** /**
* Format to display the clock. It can be 24hr or ampm. * Format to display the clock. It can be 24hr or ampm.
* @default 24hr * @default 24hr
*/ */
format?: string, format?: string,
/**
* Callback called when the picker value is changed.
*/
onChange?: Function,
/** /**
* Datetime object with currrently selected time * Datetime object with currrently selected time
*/ */
value: Date, value?: Date,
} }
class TimePicker extends React.Component<TimePickerProps, {}> { class TimePicker extends React.Component<TimePickerProps, {}> {
render(): React.DOMElement<any>; render(): React.DOMElement<any>;
@ -1030,32 +1037,35 @@ declare namespace __RT {
new (props?: P, context?: any): TooltipComponent<P, any>; new (props?: P, context?: any): TooltipComponent<P, any>;
} }
function Tooltip<P> (componentClass: React.ComponentClass<P>): TooltipComponentClass<P>; function Tooltip<P>(componentClass: React.ComponentClass<P>): TooltipComponentClass<P>;
} }
declare var AppBar: typeof __RT.AppBar; declare var AppBar: typeof __RT.AppBar;
declare module 'react-toolbox/lib/app_bar' { declare module 'react-toolbox/lib/app_bar' {
export = AppBar; export default AppBar;
} }
declare var Autocomplete: typeof __RT.Autocomplete; declare var Autocomplete: typeof __RT.Autocomplete;
declare module 'react-toolbox/lib/autocomplete' { declare module 'react-toolbox/lib/autocomplete' {
export = Autocomplete; export default Autocomplete;
} }
declare var Avatar: typeof __RT.Avatar; declare var Avatar: typeof __RT.Avatar;
declare module 'react-toolbox/lib/avatar' { declare module 'react-toolbox/lib/avatar' {
export = Avatar; export default Avatar;
} }
declare var Button: typeof __RT.Button;
declare var IconButton: typeof __RT.IconButton;
declare module 'react-toolbox/lib/button' { declare module 'react-toolbox/lib/button' {
var Button: typeof __RT.Button;
var IconButton: typeof __RT.IconButton;
export { Button, IconButton }; export { Button, IconButton };
} }
declare var Card: typeof __RT.Card;
declare var CardActions: typeof __RT.CardActions;
declare var CardMedia: typeof __RT.CardMedia;
declare var CardText: typeof __RT.CardText;
declare var CardTitle: typeof __RT.CardTitle;
declare module 'react-toolbox/lib/card' { declare module 'react-toolbox/lib/card' {
var Card: typeof __RT.Card;
var CardActions: typeof __RT.CardActions;
var CardMedia: typeof __RT.CardMedia;
var CardText: typeof __RT.CardText;
var CardTitle: typeof __RT.CardTitle;
export { export {
Card, Card,
CardActions, CardActions,
@ -1066,42 +1076,43 @@ declare module 'react-toolbox/lib/card' {
} }
declare var Checkbox: typeof __RT.Checkbox; declare var Checkbox: typeof __RT.Checkbox;
declare module 'react-toolbox/lib/checkbox' { declare module 'react-toolbox/lib/checkbox' {
export = Checkbox; export default Checkbox;
} }
declare var DatePicker: typeof __RT.DatePicker; declare var DatePicker: typeof __RT.DatePicker;
declare module 'react-toolbox/lib/date_picker' { declare module 'react-toolbox/lib/date_picker' {
export = DatePicker; export default DatePicker;
} }
declare var Dialog: typeof __RT.Dialog; declare var Dialog: typeof __RT.Dialog;
declare module 'react-toolbox/lib/dialog' { declare module 'react-toolbox/lib/dialog' {
export = Dialog; export default Dialog;
} }
declare var Drawer: typeof __RT.Drawer; declare var Drawer: typeof __RT.Drawer;
declare module 'react-toolbox/lib/drawer' { declare module 'react-toolbox/lib/drawer' {
export = Drawer; export default Drawer;
} }
declare var Dropdown: typeof __RT.Dropdown; declare var Dropdown: typeof __RT.Dropdown;
declare module 'react-toolbox/lib/dropdown' { declare module 'react-toolbox/lib/dropdown' {
export = Dropdown; export default Dropdown;
} }
declare var FontIcon: typeof __RT.FontIcon; declare var FontIcon: typeof __RT.FontIcon;
declare module 'react-toolbox/lib/font_icon' { declare module 'react-toolbox/lib/font_icon' {
export = FontIcon; export default FontIcon;
} }
declare var Input: typeof __RT.Input; declare var Input: typeof __RT.Input;
declare module 'react-toolbox/lib/input' { declare module 'react-toolbox/lib/input' {
export = Input; export default Input;
} }
declare var Link: typeof __RT.Link; declare var Link: typeof __RT.Link;
declare module 'react-toolbox/lib/link' { declare module 'react-toolbox/lib/link' {
export = Link; export default Link;
} }
declare var List: typeof __RT.List;
declare var ListItem: typeof __RT.ListItem;
declare var ListCheckbox: typeof __RT.ListCheckbox;
declare var ListSubHeader: typeof __RT.ListSubHeader;
declare var ListDivider: typeof __RT.ListDivider;
declare module 'react-toolbox/lib/list' { declare module 'react-toolbox/lib/list' {
var List: typeof __RT.List;
var ListItem: typeof __RT.ListItem;
var ListCheckbox: typeof __RT.ListCheckbox;
var ListSubHeader: typeof __RT.ListSubHeader;
var ListDivider: typeof __RT.ListDivider;
export { export {
List, List,
ListItem, ListItem,
@ -1110,11 +1121,12 @@ declare module 'react-toolbox/lib/list' {
ListDivider ListDivider
} }
} }
declare var Menu: typeof __RT.Menu;
declare var IconMenu: typeof __RT.IconMenu;
declare var MenuItem: typeof __RT.MenuItem;
declare var MenuDivider: typeof __RT.MenuDivider;
declare module 'react-toolbox/lib/menu' { declare module 'react-toolbox/lib/menu' {
var Menu: typeof __RT.Menu;
var IconMenu: typeof __RT.IconMenu;
var MenuItem: typeof __RT.MenuItem;
var MenuDivider: typeof __RT.MenuDivider;
export { export {
Menu, Menu,
IconMenu, IconMenu,
@ -1124,15 +1136,16 @@ declare module 'react-toolbox/lib/menu' {
} }
declare var Navigation: typeof __RT.Navigation; declare var Navigation: typeof __RT.Navigation;
declare module 'react-toolbox/lib/navigation' { declare module 'react-toolbox/lib/navigation' {
export = Navigation; export default Navigation;
} }
declare var ProgressBar: typeof __RT.ProgressBar; declare var ProgressBar: typeof __RT.ProgressBar;
declare module 'react-toolbox/lib/progress_bar' { declare module 'react-toolbox/lib/progress_bar' {
export = ProgressBar; export default ProgressBar;
} }
declare var RadioGroup: typeof __RT.RadioGroup;
declare var RadioButton: typeof __RT.RadioButton;
declare module 'react-toolbox/lib/radio' { declare module 'react-toolbox/lib/radio' {
var RadioGroup: typeof __RT.RadioGroup;
var RadioButton: typeof __RT.RadioButton;
export { export {
RadioGroup, RadioGroup,
RadioButton RadioButton
@ -1140,58 +1153,59 @@ declare module 'react-toolbox/lib/radio' {
} }
declare var Slider: typeof __RT.Slider; declare var Slider: typeof __RT.Slider;
declare module 'react-toolbox/lib/slider' { declare module 'react-toolbox/lib/slider' {
export = Slider; export default Slider;
} }
declare var Snackbar: typeof __RT.Snackbar; declare var Snackbar: typeof __RT.Snackbar;
declare module 'react-toolbox/lib/snackbar' { declare module 'react-toolbox/lib/snackbar' {
export = Snackbar; export default Snackbar;
} }
declare var Switch: typeof __RT.Switch; declare var Switch: typeof __RT.Switch;
declare module 'react-toolbox/lib/switch' { declare module 'react-toolbox/lib/switch' {
export = Switch; export default Switch;
} }
declare var Table: typeof __RT.Table; declare var Table: typeof __RT.Table;
declare module 'react-toolbox/lib/table' { declare module 'react-toolbox/lib/table' {
export = Table; export default Table;
} }
declare var Tab: typeof __RT.Tab;
declare var Tabs: typeof __RT.Tabs;
declare module 'react-toolbox/lib/tabs' { declare module 'react-toolbox/lib/tabs' {
var Tab: typeof __RT.Tab;
var Tabs: typeof __RT.Tabs;
export { Tab, Tabs } export { Tab, Tabs }
} }
declare var TimePicker: typeof __RT.TimePicker; declare var TimePicker: typeof __RT.TimePicker;
declare module 'react-toolbox/lib/time_picker' { declare module 'react-toolbox/lib/time_picker' {
export = TimePicker; export default TimePicker;
} }
declare var Tooltip: typeof __RT.Tooltip; declare var Tooltip: typeof __RT.Tooltip;
declare module 'react-toolbox/lib/tooltip' { declare module 'react-toolbox/lib/tooltip' {
export = Tooltip; export default Tooltip;
} }
declare module 'react-toolbox' { declare module 'react-toolbox' {
import * as AppBar from 'react-toolbox/lib/app_bar'; import AppBar from 'react-toolbox/lib/app_bar';
import * as Autocomplete from 'react-toolbox/lib/autocomplete'; import Autocomplete from 'react-toolbox/lib/autocomplete';
import * as Avatar from 'react-toolbox/lib/avatar'; import Avatar from 'react-toolbox/lib/avatar';
import { Button }from 'react-toolbox/lib/button'; import { Button }from 'react-toolbox/lib/button';
import { Card, CardActions, CardMedia, CardText, CardTitle} from 'react-toolbox/lib/card'; import { Card, CardActions, CardMedia, CardText, CardTitle} from 'react-toolbox/lib/card';
import * as Checkbox from 'react-toolbox/lib/checkbox'; import Checkbox from 'react-toolbox/lib/checkbox';
import * as DatePicker from 'react-toolbox/lib/date_picker'; import DatePicker from 'react-toolbox/lib/date_picker';
import * as Dialog from 'react-toolbox/lib/dialog'; import Dialog from 'react-toolbox/lib/dialog';
import * as Drawer from 'react-toolbox/lib/drawer'; import Drawer from 'react-toolbox/lib/drawer';
import * as Dropdown from 'react-toolbox/lib/dropdown'; import Dropdown from 'react-toolbox/lib/dropdown';
import * as FontIcon from 'react-toolbox/lib/font_icon'; import FontIcon from 'react-toolbox/lib/font_icon';
import * as Input from 'react-toolbox/lib/input'; import Input from 'react-toolbox/lib/input';
import * as Link from 'react-toolbox/lib/link'; import Link from 'react-toolbox/lib/link';
import {List, ListItem, ListCheckbox, ListSubHeader, ListDivider} from 'react-toolbox/lib/list'; import {List, ListItem, ListCheckbox, ListSubHeader, ListDivider} from 'react-toolbox/lib/list';
import {Menu, IconMenu, MenuItem, MenuDivider} from 'react-toolbox/lib/menu'; import {Menu, IconMenu, MenuItem, MenuDivider} from 'react-toolbox/lib/menu';
import * as Navigation from 'react-toolbox/lib/navigation'; import Navigation from 'react-toolbox/lib/navigation';
import * as ProgressBar from 'react-toolbox/lib/progress_bar'; import ProgressBar from 'react-toolbox/lib/progress_bar';
import {RadioGroup, RadioButton} from 'react-toolbox/lib/radio'; import {RadioGroup, RadioButton} from 'react-toolbox/lib/radio';
import * as Slider from 'react-toolbox/lib/slider'; import Slider from 'react-toolbox/lib/slider';
import * as Snackbar from 'react-toolbox/lib/snackbar'; import Snackbar from 'react-toolbox/lib/snackbar';
import * as Switch from 'react-toolbox/lib/switch'; import Switch from 'react-toolbox/lib/switch';
import { Tab, Tabs } from 'react-toolbox/lib/tabs'; import { Tab, Tabs } from 'react-toolbox/lib/tabs';
import * as TimePicker from 'react-toolbox/lib/time_picker'; import TimePicker from 'react-toolbox/lib/time_picker';
import * as Tooltip from 'react-toolbox/lib/tooltip'; import Tooltip from 'react-toolbox/lib/tooltip';
export { export {
AppBar, AppBar,