Skip to content

Commit 860d173

Browse files
committed
feat: updated LICENSE, PULL_REQUEST_TEMPLATE, README and STYLE_GUIDELINES
1 parent 5564edb commit 860d173

File tree

4 files changed

+27
-14
lines changed

4 files changed

+27
-14
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2019 Francisco Hodge
3+
Copyright (c) 2023 keyvalue software systems
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- Thank you for contributing to @keyvaluesystems/react-multi-selection-ui-component! -->
1+
<!-- Thank you for contributing to @keyvaluesystems/react-waterfall-chart! -->
22
<!-- Before submitting a pull request, please review our contributing guidelines. -->
33

44

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ You’ll need to install React separately since it isn't included in the package
3838

3939
## Usage
4040

41-
React Waterfall chart can run in a very basic mode by just providing the `transactions` like given below:
41+
React Waterfall chart can run in a very basic mode by just providing the `dataPoints` like given below:
4242

4343

4444

@@ -47,27 +47,27 @@ React Waterfall chart can run in a very basic mode by just providing the `transa
4747
import WaterfallChart from '@keyvaluesystems/react-waterfall-chart';
4848

4949
<WaterfallChart
50-
transactions={transactionList}
50+
dataPoints={dataPoints}
5151
/>
5252

5353
```
5454

5555

5656

57-
The transactions prop is an array of transactions with the following keys:
57+
The dataPoints prop is an array of dataPoint with the following keys:
5858

5959

6060

6161
- `label` - a string to represent each transaction
6262

6363
- `value` - a number that specifies the transaction quantity
6464

65-
An example for transactions array is shown below:
65+
An example for dataPoint array is shown below:
6666

6767

6868

6969
```jsx
70-
const transactionsList = [{
70+
const dataPoints = [{
7171
label: 'Quarter 1, 2020',
7272
value: 1000
7373
},{
@@ -82,7 +82,7 @@ With the help of `showBridgeLines` prop, the line connecting the adjacent bars c
8282

8383
```jsx
8484
<WaterfallChart
85-
transactions={transactionsList}
85+
dataPoints={dataPoints}
8686
barWidth={100}
8787
showBridgeLines={true}
8888
showFinalSummary={false}
@@ -95,7 +95,7 @@ You can specify whether to show or hide the scale lines in the Y axis with the h
9595

9696
```jsx
9797
<WaterfallChart
98-
transactions={transactionsList}
98+
dataPoints={dataPoints}
9999
showYAxisScaleLines={true}
100100
/>
101101
```
@@ -113,9 +113,9 @@ You can specify whether to show or hide the scale lines in the Y axis with the h
113113
</thead>
114114
<tbody>
115115
<tr>
116-
<td><code><b>transactions:</b> object[]</code></td>
116+
<td><code><b>dataPoints:</b> object[]</code></td>
117117
<td>
118-
An array of transaction objects to specifying the value and label
118+
An array of dataPoint objects to specifying the value and label
119119
</td>
120120
<td><code>[]</code></td>
121121
</tr>
@@ -162,6 +162,19 @@ The x axis label to be shown for the summary section.
162162
<td><code>Summary</code></td>
163163
</tr>
164164
<tr>
165+
<td><code><b>onMouseEnter?:</b> function</code></td>
166+
<td>
167+
The callback function which will be triggered on mouse entering the bars in the waterfall chart. The mouse event and current bar element will be passed as the prop in the function
168+
</td>
169+
<td><code>undefined</code></td>
170+
<tr>
171+
<td><code><b>onMouseLeave?:</b> function</code></td>
172+
<td>
173+
The callback function which will be triggered on mouse leaving the bars in the waterfall chart. The mouse event and current bar element will be passed as the prop in the function
174+
</td>
175+
<td><code>undefined</code></td>
176+
</tr>
177+
<tr>
165178
<td><code><b>onChartClick?:</b> function</code></td>
166179
<td>
167180
The callback function which will be triggered on clicking the bars in the waterfall chart. The current bar element will be passed as the prop in the function
@@ -187,7 +200,7 @@ the below code shows all the overridable styles:
187200

188201
```jsx
189202
<WaterfallChart
190-
transactions={transactionsList}
203+
dataPoints={dataPoints}
191204
showYAxisScaleLines={true}
192205
styles={{
193206
summaryBar: CSSProperties,

STYLE_GUIDELINES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## SCSS Style Guidelines for @keyvaluesystems/react-multi-selection-ui-component
1+
## SCSS Style Guidelines for @keyvaluesystems/react-waterfall-chart
22

33
**Introduction**
44

5-
As an open-source project utilizing SCSS, @keyvaluesystems/react-multi-selection-ui-component strives to maintain a consistent and well-structured codebase. These SCSS style guidelines serve as a reference for contributors, ensuring that their SCSS code adheres to established conventions and best practices.
5+
As an open-source project utilizing SCSS, @keyvaluesystems/react-waterfall-chart strives to maintain a consistent and well-structured codebase. These SCSS style guidelines serve as a reference for contributors, ensuring that their SCSS code adheres to established conventions and best practices.
66

77
**SCSS Coding Conventions**
88

0 commit comments

Comments
 (0)