Skip to content

Commit

Permalink
readme files (#430)
Browse files Browse the repository at this point in the history
  • Loading branch information
HUSSAR-mtrela authored Jan 16, 2024
1 parent 8455294 commit 5abb067
Show file tree
Hide file tree
Showing 580 changed files with 4,117 additions and 580 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

# Examples of Ignite UI for React Components

This repository contains over 240 examples on how to use [Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react/react/components/general-getting-started.html) components:
This repository contains over 500 examples on how to use [Ignite UI for React](https://www.infragistics.com/products/ignite-ui-react/react/components/general-getting-started.html) components:

- Charts:
[Area](https://www.infragistics.com/products/ignite-ui-react/react/components/charts/types/area-chart),
Expand Down Expand Up @@ -41,6 +41,10 @@ This repository contains over 240 examples on how to use [Ignite UI for React](h
[Date Picker](https://www.infragistics.com/products/ignite-ui-react/react/components/editors/date-picker),
[Multi-Column Combobox](https://www.infragistics.com/products/ignite-ui-react/react/components/editors/multi-column-combobox)

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Preview

You can preview and browse all samples in this repository by opening our [React Samples Browser](https://www.infragistics.com/react-demos/samples/). Alternatively, you you can view these samples with detailed information in our [React Help Documentation](https://infragistics.com/reactsite/components/general-getting-started.html).
Expand All @@ -59,11 +63,15 @@ git clone https://github.com/IgniteUI/igniteui-react-examples.git

## Running Individual Sample

- check out the **master** branch

- in VS Code, open a folder with existing sample, e.g.
```
```CMD
./samples/charts/category-chart/axis-options/
```

- type `npm install --legacy-peer-deps` command in terminal window

- type `npm run start` command in terminal window

- Wait until the build is completed and then open [http://localhost:4200](http://localhost:4200) in your browser.
Expand All @@ -73,8 +81,12 @@ At this point, you should see a website hosted example of [Ignite UI for React](

## Running All Samples

- check out the **master** branch

- open VS Code as Administrator

- open the browser folder in this repository, e.g. `C:\GitHub\igniteui-react-examples\browser`

- select **View** - **Terminal** menu item

- type `npm install --legacy-peer-deps` command in terminal window
Expand Down
8 changes: 7 additions & 1 deletion browser/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,13 @@ This folder contains source code for a React app that combines examples implemen
[Date Picker](https://www.infragistics.com/products/ignite-ui-react/react/components/editors/date-picker),
[Multi-Column Combobox](https://www.infragistics.com/products/ignite-ui-react/react/components/editors/multi-column-combobox)

## Setup
## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

Follow these instructions to run and browse all samples:

- in VS Code, open the browser folder
`C:\GitHub\igniteui-react-examples\browser`
Expand Down
8 changes: 7 additions & 1 deletion browser/templates/sample/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of {PlatformName} application with example o
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone {RepositoryUrl}.git
git checkout master
cd ./{RepositoryName}
cd {SampleFolderPath}
```
Expand Down
9 changes: 8 additions & 1 deletion samples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,20 @@ In this folder, you will find individual *samples** on how to use [Ignite UI for
[Multi-Column Combobox](https://www.infragistics.com/products/ignite-ui-react/react/components/editors/multi-column-combobox)


## Setup
## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

Follow these instructions to run an individual sample:

- in VS Code, open a folder with existing sample, e.g.
```
./samples/charts/category-chart/axis-options/
```
- type `npm install` command in terminal window

- type `npm run start` command in terminal window

- Wait until the build is completed and then open [http://localhost:4200](http://localhost:4200) in your browser.
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/annotations-all/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations-all
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/annotations-callouts/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations-callouts
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations-crosshairs
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/annotations-custom/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations-custom
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations-final-value
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations-highlighting
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/annotations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Annotat
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/annotations
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Area Ch
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/area-chart-multiple-sources
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Area Ch
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/area-chart-single-source
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/area-chart-styling/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Area Ch
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/area-chart-styling
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/axis-gap/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Axis Ga
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/axis-gap
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/axis-gridlines/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Axis Gr
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/axis-gridlines
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/axis-inverted/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Axis In
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/axis-inverted
```
Expand Down
8 changes: 7 additions & 1 deletion samples/charts/category-chart/axis-labels/ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ This folder contains implementation of React application with example of Axis La
</body>
</html>

## Branches

> **_NOTE:_** You should use [master](https://github.com/IgniteUI/igniteui-react-examples/tree/master) branch of this repository if you want to run samples on your computer. Use the [vnext](https://github.com/IgniteUI/igniteui-react-examples/tree/vnext) branch only when you want to contribute new samples to this repository.
## Instructions

To set up this project locally, execute these commands:
Follow these instructions to run this example:


```
git clone https://github.com/IgniteUI/igniteui-react-examples.git
git checkout master
cd ./igniteui-react-examples
cd ./samples/charts/category-chart/axis-labels
```
Expand Down
Loading

0 comments on commit 5abb067

Please sign in to comment.