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

Sample refactoring #98

Merged
merged 1 commit into from
Jan 23, 2018
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
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Ignite UI Components for React

[![Build Status](https://travis-ci.org/IgniteUI/igniteui-react.svg?branch=master)](https://travis-ci.org/IgniteUI/igniteui-react?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/IgniteUI/igniteui-react/badge.svg?branch=master)](https://coveralls.io/github/IgniteUI/igniteui-react?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/IgniteUI/igniteui-react/badge.svg?branch=master)](https://coveralls.io/github/IgniteUI/igniteui-react?branch=master)
[![npm version](https://badge.fury.io/js/igniteui-react.svg)](https://badge.fury.io/js/igniteui-react)

Use the declarations available in `igniteui-react.js` (or `igniteui-react.min.js`) to use [Ignite UI](http://igniteui.com) controls as [React](https://facebook.github.io/react/) components. [Work with the running samples here](https://igniteui.github.io/igniteui-react/).
Expand Down Expand Up @@ -72,7 +72,7 @@ Optionally include `browser.js` found in the `Babel-core` package for [JSX](http
This provides all supported Ignite UI components as React classes available in the global namespace.

## Initializing controls
In general React components can be initialized in two ways:
In general React components can be initialized in two ways:

1. In `JavaScript` using React's API.
2. With pseudo-markup by utilizing `JSX` syntax.
Expand Down Expand Up @@ -114,7 +114,7 @@ Defining complex type control options (`arrays` & `objects`) in `JSX` is done by

#### Example:

<IgGrid
<IgGrid
id="grid1"
columns={[
{ headerText: "Product ID", key: "ProductID", dataType: "number" },
Expand Down Expand Up @@ -142,7 +142,7 @@ Option updates during runtime can be achieved by using React's [setState](https:
render: function () {
return (
<div>
<IgGrid
<IgGrid
id="grid1"
autoGenerateColumns={true}
dataSource={sourceData}
Expand Down Expand Up @@ -195,6 +195,15 @@ Or get the DOM element it is initialized on and calling the method through jQuer
$.ig.react.core.getElement(gridComponent).igGrid("commit");
```

## Running our samples:

Go to the folder of the sample you want to run:

npm install
npm start

Alternatively you can view them from [here](https://igniteui.github.io/igniteui-react/).

## Testing

Testing IgniteUI React is done through Unit tests. All of them are written in [Jasmine](http://jasmine.github.io/).
Expand Down
Loading