Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 6cd253a

Browse files
Vishnu-MoorthiVishnu-Moorthi
Vishnu-Moorthi
authored and
Vishnu-Moorthi
committed
README.md file updated
1 parent 1fefa7a commit 6cd253a

File tree

2 files changed

+18
-46
lines changed

2 files changed

+18
-46
lines changed

‎README.md

Lines changed: 18 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -8,65 +8,37 @@ The Syncfusion Grid component is a remarkable front-end tool that can be seamles
88

99
## Installation
1010

11-
To Install Syncfusuion Streamlit Grid component use the following command.
12-
13-
The Packages and application required for rendering components are,
14-
15-
* [Anaconda Navigator](https://docs.anaconda.com/navigator/).
16-
17-
* [Streamlit module](https://pypi.org/project/streamlit/).
18-
19-
* [Node JS ( v10.24.1 )](https://nodejs.org/en/blog/release/v10.24.1/).
20-
21-
* [React JS](https://reactjs.org/docs/getting-started.html) (optional).
22-
23-
## Setup
24-
25-
After the installation of all required packages. Follow the instruction to setup the development environment.
26-
27-
* Clone the Streamlit [component-template](https://github.com/streamlit/component-template) GitHub repository to the local machine.
28-
29-
* Choose the template from the [component-template](https://github.com/streamlit/component-template) repo whether React platform or not and Use the chosen template folder.
30-
31-
* Inside the `template` folder rename the folder `my-component` to the module name that will reflect on the [pipy.org](https://pypi.org/project/pip/).
32-
33-
## Implementation
34-
35-
The implementation needs basic knowledge of the Python programming language.
36-
37-
### Deployment of the JavaScript / HTML component.
38-
39-
* Open the renamed `my-component` folder on a [VS Code](https://code.visualstudio.com/) (or any other `Text-Editor`).
40-
41-
* Install all default dependent packages, use the following command.
11+
Use the following command to install the Syncfusion Streamlit Grid component.
4212

4313
```sh
44-
npm install
45-
```
46-
* Install dependent packages for the component using following command
47-
```sh
48-
npm install <package-name> --save
14+
pip install ej2_streamlit_grids
4915
```
5016

51-
* Deploy the component code on the respective `*.tsx` file inside the folder : `my-component / frontend / src`.
17+
## Implementation
5218

53-
> Note: Dynamic data should be passed from the streamlit backend. So, No need to implement the dynamic data on the frontend.
19+
Create a simple demo.py file as follows:
5420

55-
* The gate-way of the component should starts from the `index.tsx` file with streamlit integration. The component should be finally rendered with streamlit.
21+
```py
22+
from ej2_streamlit_grids import GridComponent, GridProps
23+
import pandas as pd
5624

57-
* Once all the coding were implemented, Run the component on the local server by executing `npm start` command on the Terminal or Command prompt ( CMD ).
25+
data = pd.read_csv('dataset.csv')
26+
props = GridProps(data)
5827

59-
### Deployment of Component on the Streamlit.
28+
GridComponent(props)
29+
```
6030

61-
* After the development server started, open the `my-component` folder on the another window of the [VS Code](https://code.visualstudio.com/) (or any other `Text-Editor`).
31+
Use the following command to run the application:
6232

63-
* Now open `__init__.py` file, It acts like a constructor for the Python package when the component package get imported, the `__init__.py` file initiated.
33+
![demo](./demos/ej2_streamlit_grids_demo.gif)
6434

65-
* In `__init__.py` file, rename the class name `my_component` that denotes our Component, the constructor holds the parameter which are passed to the `JS` or `HTML` file.
35+
```sh
36+
streamlit run demo.py
37+
```
6638

67-
* The Values or Options are passed to the front end by the `_component_func()` as a parameter from here and received at the front-end as `props.args`.
39+
## Demo
6840

69-
* Can create another python module to implement the Features to the component, which are manipulated at the `__init__.py` file and passes to the component only as a single parameter.
41+
The Grid sample is showcased with few feature.
7042

7143
## Support
7244

‎demos/ej2_streamlit_grids_demo.gif

4.92 MB
Loading[フレーム]

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /