@innovaccer/design-system 2.5.0-2 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/.all-contributorsrc +170 -0
  2. package/.github/workflows/jira.yml +1 -2
  3. package/.github/workflows/main.yml +1 -6
  4. package/.github/workflows/test.yml +22 -0
  5. package/CHANGELOG.md +21 -54
  6. package/CONTRIBUTING.md +23 -0
  7. package/README.md +124 -75
  8. package/core/components/atoms/button/Button.tsx +56 -55
  9. package/core/components/atoms/button/__tests__/Button.test.tsx +3 -12
  10. package/core/components/atoms/checkbox/Checkbox.tsx +3 -6
  11. package/core/components/atoms/collapsible/__stories__/index.story.tsx +2 -2
  12. package/core/components/atoms/dropdown/DropdownList.tsx +1 -1
  13. package/core/components/atoms/dropdown/__stories__/Options.tsx +15 -0
  14. package/core/components/atoms/dropdown/__tests__/Dropdown.test.tsx +202 -1
  15. package/core/components/atoms/dropdown/__tests__/Option.test.tsx +3 -0
  16. package/core/components/atoms/message/__stories__/CustomDescription.tsx +25 -0
  17. package/core/components/atoms/metaList/Meta.tsx +3 -1
  18. package/core/components/atoms/metaList/__tests__/MetaList.test.tsx +30 -36
  19. package/core/components/atoms/metricInput/MetricInput.tsx +2 -2
  20. package/core/components/atoms/outsideClick/__stories__/index.story.tsx +1 -1
  21. package/core/components/atoms/radio/Radio.tsx +7 -10
  22. package/core/components/atoms/radio/__tests__/Radio.test.tsx +13 -7
  23. package/core/components/css-utilities/Align/Align.story.tsx +1 -1
  24. package/core/components/css-utilities/Background/Background.story.tsx +1 -1
  25. package/core/components/css-utilities/Border/Border.story.tsx +128 -0
  26. package/core/components/css-utilities/Display/Display.story.tsx +1 -1
  27. package/core/components/css-utilities/Flex/Flex.story.tsx +1 -1
  28. package/core/components/css-utilities/Miscellaneous/Miscellaneous.story.tsx +1 -1
  29. package/core/components/css-utilities/Overflow/Overflow.story.tsx +1 -1
  30. package/core/components/css-utilities/Position/Position.story.tsx +1 -1
  31. package/core/components/css-utilities/Sizing/Sizing.story.tsx +1 -1
  32. package/core/components/css-utilities/Spacing/Spacing.story.tsx +1 -1
  33. package/core/components/molecules/chatMessage/__tests__/ChatMessage.test.tsx +20 -46
  34. package/core/components/molecules/dropzone/__tests__/Dropzone.test.tsx +47 -111
  35. package/core/components/molecules/dropzone/__tests__/Utilities.test.tsx +13 -13
  36. package/core/components/molecules/editableChipInput/EditableChipInput.tsx +3 -1
  37. package/core/components/molecules/editableInput/EditableInput.tsx +5 -3
  38. package/core/components/molecules/editableInput/__stories__/variants/Uncontrolled.story.tsx +1 -1
  39. package/core/components/molecules/editableInput/__tests__/EditableInput.test.tsx +1 -3
  40. package/core/components/molecules/emptyState/_tests_/EmptyState.test.tsx +3 -7
  41. package/core/components/molecules/fileUploader/FileUploaderItem.tsx +13 -2
  42. package/core/components/molecules/fileUploader/__stories__/index.story.tsx +156 -21
  43. package/core/components/molecules/fileUploader/__tests__/FileUploader.test.tsx +21 -80
  44. package/core/components/molecules/fileUploader/__tests__/FileUploaderList.test.tsx +9 -40
  45. package/core/components/molecules/fullscreenModal/FullscreenModal.tsx +7 -13
  46. package/core/components/molecules/fullscreenModal/__stories__/Layering.story.tsx +2 -2
  47. package/core/components/molecules/modal/Modal.tsx +18 -17
  48. package/core/components/molecules/modal/ModalBody.tsx +1 -1
  49. package/core/components/molecules/modal/__stories__/Layering.story.tsx +1 -1
  50. package/core/components/molecules/modal/__stories__/NoFooter.story.tsx +0 -1
  51. package/core/components/molecules/modal/__stories__/Scrolling.story.tsx +20 -38
  52. package/core/components/molecules/modal/__tests__/Modal.test.tsx +1 -1
  53. package/core/components/molecules/sidesheet/Sidesheet.tsx +16 -17
  54. package/core/components/organisms/choiceList/ChoiceList.tsx +212 -0
  55. package/core/components/organisms/choiceList/__stories__/Alignment.story.tsx +32 -0
  56. package/core/components/organisms/choiceList/__stories__/AllowMultiple.story.tsx +23 -0
  57. package/core/components/organisms/choiceList/__stories__/Controlled.story.tsx +34 -0
  58. package/core/components/organisms/choiceList/__stories__/index.story.tsx +18 -0
  59. package/core/components/organisms/choiceList/__tests__/ChoiceList.test.tsx +155 -0
  60. package/core/components/organisms/choiceList/__tests__/__snapshots__/ChoiceList.test.tsx.snap +3393 -0
  61. package/core/components/organisms/choiceList/index.tsx +2 -0
  62. package/core/components/organisms/datePicker/__tests__/DatePicker.test.tsx +136 -46
  63. package/core/components/organisms/datePicker/__tests__/__snapshots__/DatePicker.test.tsx.snap +2594 -102
  64. package/core/components/organisms/dateRangePicker/DateRangePicker.tsx +5 -0
  65. package/core/components/organisms/dateRangePicker/__tests__/DateRangePicker.test.tsx +49 -410
  66. package/core/components/organisms/dateRangePicker/__tests__/Utilities.test.tsx +39 -0
  67. package/core/components/organisms/dateRangePicker/__tests__/__snapshots__/DateRangePicker.test.tsx.snap +45390 -2679
  68. package/core/components/organisms/dateRangePicker/utilities.tsx +2 -5
  69. package/core/components/organisms/grid/Cell.tsx +5 -4
  70. package/core/components/organisms/grid/Grid.tsx +1 -1
  71. package/core/components/organisms/grid/GridCell.tsx +18 -7
  72. package/core/components/organisms/grid/GridHead.tsx +1 -1
  73. package/core/components/organisms/grid/GridRow.tsx +5 -12
  74. package/core/components/organisms/grid/__tests__/Grid.test.tsx +179 -1
  75. package/core/components/organisms/grid/__tests__/GridCell.test.tsx +218 -0
  76. package/core/components/organisms/grid/__tests__/__snapshots__/Grid.test.tsx.snap +1024 -0
  77. package/core/components/organisms/grid/__tests__/rowUtility.test.tsx +62 -0
  78. package/core/components/organisms/inlineMessage/InlineMessage.tsx +10 -14
  79. package/core/components/organisms/inlineMessage/__stories__/InlineMessageWithinTable.story.tsx +9 -12
  80. package/core/components/organisms/inlineMessage/__stories__/variants/Default.story.tsx +2 -4
  81. package/core/components/organisms/inlineMessage/__stories__/variants/Error.story.tsx +2 -5
  82. package/core/components/organisms/inlineMessage/__stories__/variants/Info.story.tsx +2 -5
  83. package/core/components/organisms/inlineMessage/__stories__/variants/Success.story.tsx +2 -5
  84. package/core/components/organisms/inlineMessage/__stories__/variants/Warning.story.tsx +2 -5
  85. package/core/components/organisms/inlineMessage/__tests__/InlineMessage.test.tsx +4 -20
  86. package/core/components/organisms/navigation/VerticalNavigation.tsx +14 -3
  87. package/core/components/organisms/navigation/__tests__/Navigation.test.tsx +179 -0
  88. package/core/components/organisms/navigation/__tests__/__snapshots__/Navigation.test.tsx.snap +530 -0
  89. package/core/components/organisms/table/DraggableDropdown.tsx +1 -0
  90. package/core/components/organisms/table/Header.tsx +11 -2
  91. package/core/components/organisms/table/Table.tsx +2 -2
  92. package/core/components/organisms/table/__stories__/NestedTableWithNestedCard.story.tsx +4 -1
  93. package/core/components/organisms/table/__stories__/variants/nestedRows.story.tsx +5 -2
  94. package/core/components/organisms/table/__tests__/Table.test.tsx +292 -0
  95. package/core/components/organisms/table/__tests__/__snapshots__/Table.test.tsx.snap +349041 -0
  96. package/core/components/organisms/timePicker/__tests__/TimePicker.test.tsx +15 -66
  97. package/core/components/patterns/dateRangePicker/withCustomPopover.story.tsx +47 -36
  98. package/core/index.tsx +1 -1
  99. package/core/index.type.tsx +1 -0
  100. package/core/utils/OverlayManager.tsx +1 -3
  101. package/core/utils/__tests__/__snapshots__/TS.test.tsx.snap +4 -0
  102. package/core/utils/types.tsx +3 -4
  103. package/css/dist/index.css +78 -8
  104. package/css/dist/index.css.map +1 -1
  105. package/css/src/components/button.css +8 -4
  106. package/css/src/components/choiceList.css +25 -0
  107. package/css/src/components/modal.css +1 -2
  108. package/css/src/utils/border.css +39 -0
  109. package/dist/core/components/atoms/popperWrapper/PopperWrapper.d.ts +50 -49
  110. package/dist/core/components/css-utilities/Border/Border.story.d.ts +13 -0
  111. package/dist/core/components/organisms/choiceList/ChoiceList.d.ts +33 -0
  112. package/dist/core/components/organisms/choiceList/index.d.ts +2 -0
  113. package/dist/core/components/organisms/dateRangePicker/utilities.d.ts +2 -2
  114. package/dist/core/index.d.ts +1 -0
  115. package/dist/core/index.type.d.ts +1 -0
  116. package/dist/index.esm.js +207 -58
  117. package/dist/index.js +209 -57
  118. package/dist/index.js.map +1 -1
  119. package/dist/index.umd.js +1 -1
  120. package/dist/index.umd.js.br +0 -0
  121. package/dist/index.umd.js.gz +0 -0
  122. package/jest.config.js +2 -1
  123. package/package.json +6 -4
@@ -0,0 +1,170 @@
1
+ {
2
+ "projectName": "design-system",
3
+ "projectOwner": "innovaccer",
4
+ "repoType": "github",
5
+ "repoHost": "https://github.com",
6
+ "files": [
7
+ "README.md"
8
+ ],
9
+ "imageSize": 100,
10
+ "commit": false,
11
+ "commitConvention": "angular",
12
+ "contributors": [
13
+ {
14
+ "login": "aditya-kumawat",
15
+ "name": "Aditya Kumawat",
16
+ "avatar_url": "https://avatars.githubusercontent.com/u/12715487?v=4",
17
+ "profile": "https://github.com/aditya-kumawat",
18
+ "contributions": [
19
+ "code"
20
+ ]
21
+ },
22
+ {
23
+ "login": "riyalohia",
24
+ "name": "Riya Lohia",
25
+ "avatar_url": "https://avatars.githubusercontent.com/u/31706090?v=4",
26
+ "profile": "https://riyalohia.github.io/portfolio/",
27
+ "contributions": [
28
+ "code"
29
+ ]
30
+ },
31
+ {
32
+ "login": "satyamyadav",
33
+ "name": "Satyam Yadav",
34
+ "avatar_url": "https://avatars.githubusercontent.com/u/3583587?v=4",
35
+ "profile": "http://satyamyadav.info/",
36
+ "contributions": [
37
+ "code",
38
+ "doc",
39
+ "review"
40
+ ]
41
+ },
42
+ {
43
+ "login": "sandeshchoudhary",
44
+ "name": "sandeshchoudhary",
45
+ "avatar_url": "https://avatars.githubusercontent.com/u/11272274?v=4",
46
+ "profile": "https://github.com/sandeshchoudhary",
47
+ "contributions": [
48
+ "code"
49
+ ]
50
+ },
51
+ {
52
+ "login": "adityajhajharia",
53
+ "name": "adityajhajharia",
54
+ "avatar_url": "https://avatars.githubusercontent.com/u/42600089?v=4",
55
+ "profile": "https://github.com/adityajhajharia",
56
+ "contributions": [
57
+ "code"
58
+ ]
59
+ },
60
+ {
61
+ "login": "anuradha9712",
62
+ "name": "Anuradha Aggarwal",
63
+ "avatar_url": "https://avatars.githubusercontent.com/u/46045493?v=4",
64
+ "profile": "https://github.com/anuradha9712",
65
+ "contributions": [
66
+ "code"
67
+ ]
68
+ },
69
+ {
70
+ "login": "xlreon",
71
+ "name": "Sidharth",
72
+ "avatar_url": "https://avatars.githubusercontent.com/u/26788670?v=4",
73
+ "profile": "https://github.com/xlreon",
74
+ "contributions": [
75
+ "code"
76
+ ]
77
+ },
78
+ {
79
+ "login": "stuti1090",
80
+ "name": "stuti1090",
81
+ "avatar_url": "https://avatars.githubusercontent.com/u/65341865?v=4",
82
+ "profile": "https://github.com/stuti1090",
83
+ "contributions": [
84
+ "code"
85
+ ]
86
+ },
87
+ {
88
+ "login": "veekays",
89
+ "name": "Vikas Singh",
90
+ "avatar_url": "https://avatars.githubusercontent.com/u/6420348?v=4",
91
+ "profile": "https://github.com/veekays",
92
+ "contributions": [
93
+ "code"
94
+ ]
95
+ },
96
+ {
97
+ "login": "SaniyaGupta",
98
+ "name": "SaniyaGupta",
99
+ "avatar_url": "https://avatars.githubusercontent.com/u/15903031?v=4",
100
+ "profile": "https://github.com/SaniyaGupta",
101
+ "contributions": [
102
+ "code"
103
+ ]
104
+ },
105
+ {
106
+ "login": "chauhanparth210",
107
+ "name": "Parth Chauhan",
108
+ "avatar_url": "https://avatars.githubusercontent.com/u/35137224?v=4",
109
+ "profile": "https://www.linkedin.com/in/parth-chauhan-984624193/",
110
+ "contributions": [
111
+ "code"
112
+ ]
113
+ },
114
+ {
115
+ "login": "stutirao",
116
+ "name": "Stuti Pandey",
117
+ "avatar_url": "https://avatars.githubusercontent.com/u/45294592?v=4",
118
+ "profile": "https://github.com/stutirao",
119
+ "contributions": [
120
+ "code"
121
+ ]
122
+ },
123
+ {
124
+ "login": "Shib00",
125
+ "name": "Shivam Dwivedi",
126
+ "avatar_url": "https://avatars.githubusercontent.com/u/33096446?v=4",
127
+ "profile": "https://github.com/Shib00",
128
+ "contributions": [
129
+ "code"
130
+ ]
131
+ },
132
+ {
133
+ "login": "aregee",
134
+ "name": "Rahul Gaur",
135
+ "avatar_url": "https://avatars.githubusercontent.com/u/760474?v=4",
136
+ "profile": "http://www.rahulgaur.info/",
137
+ "contributions": [
138
+ "code"
139
+ ]
140
+ },
141
+ {
142
+ "login": "atifzaidi92",
143
+ "name": "atifzaidi92",
144
+ "avatar_url": "https://avatars.githubusercontent.com/u/54103064?v=4",
145
+ "profile": "https://github.com/atifzaidi92",
146
+ "contributions": [
147
+ "code"
148
+ ]
149
+ },
150
+ {
151
+ "login": "Sumit2399",
152
+ "name": "Sumit Dhyani",
153
+ "avatar_url": "https://avatars.githubusercontent.com/u/66456021?v=4",
154
+ "profile": "https://github.com/Sumit2399",
155
+ "contributions": [
156
+ "code"
157
+ ]
158
+ },
159
+ {
160
+ "login": "927tanmay",
161
+ "name": "Tanmay Sharma",
162
+ "avatar_url": "https://avatars.githubusercontent.com/u/36269283?v=4",
163
+ "profile": "https://tanmay-portfolio.herokuapp.com/",
164
+ "contributions": [
165
+ "code"
166
+ ]
167
+ }
168
+ ],
169
+ "contributorsPerLine": 7
170
+ }
@@ -28,7 +28,6 @@ jobs:
28
28
  ${{ github.event.issue.title }}
29
29
  description: |
30
30
  ${{ github.event.issue.body }}
31
- fields: '{"labels":["github"], "customfield_10018": "DS-843", "customfield_11120":"${{ github.event.issue.html_url }}", "customfield_11760":{"value":"No"}}'
32
-
31
+ fields: '{"labels":["github"], "customfield_10018": "${{ secrets.JIRA_ID }}", "customfield_11120":"${{ github.event.issue.html_url }}", "customfield_11760":{"value":"No"}}'
33
32
  - name: Log created issue
34
33
  run: echo "Issue ${{ steps.create.outputs.issue }} was created"
@@ -2,7 +2,7 @@ name: "Test build release"
2
2
  on:
3
3
  push:
4
4
  branches:
5
- - master
5
+ - 2.5.x
6
6
  jobs:
7
7
  release:
8
8
  # uncomment next line as soon as visual tesing starts working
@@ -62,11 +62,6 @@ jobs:
62
62
  if: steps.is_release_commit.outputs.result == 1
63
63
  run: git push https://${{ secrets.GH_TOKEN }}@github.com/$GITHUB_REPOSITORY.git HEAD:master
64
64
 
65
- - name: deploy storybook
66
- env:
67
- GH_TOKEN: ${{ secrets.GH_TOKEN }}
68
- if: steps.is_release_commit.outputs.result == 1
69
- run: npm run deploy-storybook -- --ci
70
65
 
71
66
  - name: notify release
72
67
  if: steps.is_release_commit.outputs.result == 1
@@ -0,0 +1,22 @@
1
+ name: "Test"
2
+ on:
3
+ push:
4
+ branches:
5
+ - 2.5.x
6
+ jobs:
7
+ test:
8
+ name: Test for coverage
9
+ runs-on: ubuntu-latest
10
+ steps:
11
+ - uses: actions/checkout@v1
12
+
13
+ - uses: actions/setup-node@v1
14
+ with:
15
+ node-version: '10.x'
16
+
17
+ - name: npm install
18
+ run: npm install
19
+
20
+ - name: test
21
+ run: npm run test
22
+
package/CHANGELOG.md CHANGED
@@ -1,7 +1,10 @@
1
- ## 2.5.0-2 (2021-09-29)
1
+
2
+ ## 2.5.0 (2021-10-25)
2
3
 
3
4
  ### Highlights
4
- NA
5
+ * A now component ChoiceList is added to use group of check box or radio inputs to work as a choice selector (2d9bb1ed)
6
+ * Calendar and DatePicker has new design and features for today date selection now. (7c3df346)
7
+ * All existing contributors are added to Readme, an option to create request for getting added as contributor and documentation for the same is added. (07db26e9)
5
8
 
6
9
  ### Breaking changes
7
10
  NA
@@ -13,71 +16,35 @@ NA
13
16
  NA
14
17
 
15
18
  ### Features
19
+ * A now component ChoiceList is added to use group of check box or radio inputs to work as a choice selector (2d9bb1ed)
20
+ * New helper classes for applying border or removing border of an element are added. (7675c8b3)
16
21
  * Calendar and DatePicker has new design and features for today date selection now. (7c3df346)
17
22
  * EmptyState component now supports inline SVG image. (863d69b0)
23
+ * Added previous and next month dates in current month's date in Calendar Component (4fe810bf)
18
24
 
19
25
  ### Fixes
26
+ * fix(button.css): fix active state in transparent button (1c499f0d)
27
+ * fix(nestedtable): fix expand and collapse button issue (be69d5e5)
28
+ * Issue in scrolling horizontally on a Table body not scrolled table header is resolved. (e71ea1c2)
29
+ * Icons on Table header and column menu to sort the table are now pointed in correct directions. (718a1a37)
30
+ * DateRangePicker pattern example now uses selection cheap in stead of radios for pre defined date range selections. (a1d0ee53)
20
31
  * Table/Grid horizontal scrolling issue is fixed. (a6949715)
21
32
  * Modal is now vertically centered and can have flexible heights. (ef6072a7)
22
33
  * Dropzone icon is visible now when we bring mouse to drop file over it. (5ba93be9)
23
-
24
- ### Improvements
25
- NA
26
-
27
- ### Documentation
28
- * Guideline for branch naming convention added. (1ef3cd96)
29
-
30
- -------------------
31
-
32
- ## 2.5.0-1 (2021-09-27)
33
-
34
- ### Highlights
35
- NA
36
-
37
- ### Breaking changes
38
- NA
39
-
40
- ### Migration guide
41
- NA
42
-
43
- ### Deprecations
44
- NA
45
-
46
- ### Features
47
- NA
48
- ### Fixes
49
34
  * Fixes the table header scroll when table body scroll (502cb1d1)
50
35
  * Fixes the Tabs Component rendering issue with checking children component type (8525a4e7)
51
36
  * Fixes the Datepicker snapshot which was getting updated as date changes (c001e925)
52
- ### Improvements
53
- NA
54
- ### Documentation
55
- NA
56
-
57
- -------------------
58
-
59
- ## 2.5.0-0 (2021-09-22)
60
-
61
- ### Highlights
62
- NA
63
-
64
- ### Breaking changes
65
- NA
66
37
 
67
- ### Migration guide
68
- NA
69
-
70
- ### Deprecations
71
- NA
72
-
73
- ### Features
74
- * Added previous and next month dates in current month's date in Calendar Component (4fe810bf)
75
- ### Fixes
76
- NA
77
38
  ### Improvements
78
- * Added test cases for Calendar Component (f22df8b6)
39
+ * Improved test coverage to cover more than 92% of the code base.
40
+
79
41
  ### Documentation
80
- NA
42
+ * FileUploader component example is now more interactive (509a9053)
43
+ * Navigation is more structured on story book for css and other utilities (56999d6b)
44
+ * Message component example improved for versatile use-cases. (16fe6be6)
45
+ * Readme is structured and updated for easy to access the required information (7d9c262d)
46
+ * All existing contributors are added to Readme, an option to create request for getting added as contributor and documentation for the same is added. (07db26e9)
47
+ * Guideline for branch naming convention added. (1ef3cd96)
81
48
 
82
49
  -------------------
83
50
  ## 2.4.0 (2021-09-22)
package/CONTRIBUTING.md CHANGED
@@ -724,3 +724,26 @@ and `chore:` are valid but have no effect on versioning. **It would be great if
724
724
 
725
725
  **For any change in source code of components that changes the API or functioning of the component corresponding story should be updated or a new story should be included**.
726
726
 
727
+
728
+ ## Add yourself to the contributor list
729
+
730
+ We want to make sure everyone is recognized for their contributions !
731
+ To add yourself to the `all-contributors` table in the README, you'll need to
732
+ run the following commands from the root of the repo:
733
+
734
+ ```sh
735
+ # Add new contributor <username>, who made a contribution of type <contribution>
736
+ ./node_modules/.bin/all-contributors add <username> <contribution>
737
+ # Example:
738
+ ./node_modules/.bin/all-contributors add satyamyadav code,doc
739
+ ```
740
+
741
+ Then, you'll need to generate the updated `all-contributors` table by running
742
+
743
+ ```sh
744
+ all-contributors generate
745
+ OR
746
+ ./node_modules/.bin/all-contributors generate
747
+
748
+ ```
749
+
package/README.md CHANGED
@@ -4,124 +4,137 @@
4
4
  </a>
5
5
  </p>
6
6
  <h1 align="center">
7
- Innovaccer Design System
7
+ Masala Design System
8
8
  </h1>
9
- <h3 align="center">
10
- A React-based UI toolkit for building Web Applications.
11
- </h3>
12
9
 
10
+ > Masala Design System (MDS) is an open-source design system built at Innovaccer.
11
+ > This is a simple and customizable component library to build faster, beautiful,
12
+ > and more accessible React applications on the guidelines and principles of
13
+ > Masala Design System.
13
14
 
14
- ## 🚀 Get Up and Running
15
-
16
- >💡 If your app runs on `Innovaccer UI engine` you don't need following two steps, please see *Using Components* section bellow.
15
+ <br/>
17
16
 
18
- There are two main steps to use a component in your project:
19
- 1. Installing component library using npm or yarn.
20
- 2. Loading stylesheet.
17
+ <div align="center">
21
18
 
19
+ [![codecov](https://codecov.io/gh/innovaccer/design-system/branch/master/graph/badge.svg?token=2LY7JLZGX0)](https://codecov.io/gh/innovaccer/design-system) ![GitHub](https://img.shields.io/github/license/innovaccer/design-system) ![GitHub top language](https://img.shields.io/github/languages/top/innovaccer/design-system) ![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/innovaccer/design-system)
22
20
 
23
- **Installing component library:**
21
+ </div>
22
+ <br/>
24
23
 
24
+ ## 🚀 Get Up and Running
25
25
 
26
- Run the following command using [npm](https://www.npmjs.com/) to add the component library to your project:
26
+ To install `@innovaccer/design-system` in your project, you will need to run the
27
+ following command using [npm](https://www.npmjs.com/):
27
28
 
28
29
  ```bash
29
30
  npm install @innovaccer/design-system
30
31
  ```
31
32
 
32
- **Adding style:**
33
+ If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
34
+ instead:
33
35
 
34
- As this component library is part of a framework-agnostic design system used at Innovaccer the styling is done with CSS using CSS variables for theming and BEM methodology for reusable and modular styling. So it requires you to include CSS in your project by either importing or serving it as a static file. The complete stylesheet is published as part of the component library at path `@innovaccer/design-system/css`.
36
+ ```bash
37
+ yarn add @innovaccer/design-system
38
+ ```
35
39
 
36
- Import style at your app's root.
40
+ **Adding style:**
41
+
42
+ Import style at your app's root, it is not included in library bundle and shipped as a single css file.
43
+ For more details see our [styling](#styling) section
37
44
 
38
45
  ```js
39
46
  import '@innovaccer/design-system/css';
40
47
  ```
41
48
 
42
- **Using design system font:**
43
49
 
44
- The css sets the font family as `'Nunito Sans'` for the body. To add this font in your project you need to load this font. The recommended way to do it is by adding the following google font cdn link to your app's head.
45
50
 
46
- ```html
47
- <link href="https://fonts.googleapis.com/css?family=Nunito+Sans:300,300i,400,400i,600,600i,700,700i,800,800i,900,900i&display=swap" rel="stylesheet">
51
+ If you want to try out `@innovaccer/design-system`, you can also use
52
+ [CodeSandbox](https://codesandbox.io/s/focused-germain-shbcw).
48
53
 
49
- ```
54
+ [![Edit @innovaccer/design-system](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/focused-germain-shbcw)
50
55
 
51
- **Updating Font:**
52
56
 
53
- If you don't add the font described above font family will not be affected by css. However, if you want to update the font family update it via the following css variable.
57
+ ## Usage
54
58
 
55
- ```css
56
- --font-family
59
+ ```js
60
+ import { Button } from '@innovaccer/design-system';
61
+ const App = () => {
62
+ return <Button>Done</Button>;
63
+ };
57
64
  ```
58
65
 
59
- **Reset Styles**
66
+ For more information about each component, check out our
67
+ [Storybook](https://innovaccer.github.io/design-system/).
68
+ Check out our [Tutorial](/docs/AppTutorial.md) to guide you in creating an awesome app.
60
69
 
61
- As BEM is used reset.css is not used and no style reset is done.
70
+ ## CDN
62
71
 
63
- **Polyfill for IE**
64
-
65
- For css variables to work on IE we use a polyfill at runtime to achieve dynamic theming through variables. Please add the following polyfill in your page.
72
+ If you prefer to include library globally by marking it as external in your application, [library](https://unpkg.com/browse/@innovaccer/design-system/) provides various single-file distributions, which can be used as following:
66
73
 
67
74
  ```html
68
- <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
69
- <script>
70
- cssVars({
71
- onlyLegacy: true
72
- });
73
- </script>
75
+ <!-- style -->
76
+ <link href="https://unpkg.com/@innovaccer/design-system@2.5.0-3/css/dist/index.css" rel="stylesheet" />
77
+
78
+ <!-- un-compressed UMD -->
79
+ <script src="https://unpkg.com/browse/@innovaccer/design-system@2.5.0-3/dist/index.umd.js"></script>
80
+
81
+ <!-- brotli compressed UMD -->
82
+ <script src="https://unpkg.com/@innovaccer/design-system@2.5.0-3/dist/index.umd.js.br"></script>
74
83
 
84
+ <!-- gzip compressed UMD -->
85
+ <script src="https://unpkg.com/@innovaccer/design-system@2.5.0-3/dist/index.umd.js.gz"></script>
75
86
  ```
76
87
 
77
- **Using Components**
88
+ ## Styling
78
89
 
79
- Available components along with live code editor and API documentation can be found [here](https://innovaccer.github.io/design-system).
80
- Components can be imported as mentioned below:
90
+ As this component library is part of a framework-agnostic design system used at Innovaccer the styling is done with CSS using CSS variables for theming and BEM methodology for reusable and modular styling. So it requires you to include CSS in your project by either importing or serving it as a static file. The complete stylesheet is published as part of the component library at path `@innovaccer/design-system/css`.
91
+ You can include css by importing it or loading it from cdn.
81
92
 
93
+ **👉 Using Font**
82
94
 
83
- ```js
84
- {
85
- ...
86
- Avatar,
87
- Backdrop,
88
- Badge,
89
- BreadcrumbsWrapper,
90
- Breadcrumb,
91
- ...
92
- } from '@innovaccer/design-system'
95
+ The css sets the font family as `'Nunito Sans'` for the body. To add this font in your project you need to load this font. The recommended way to do it is by adding the following google font cdn link to your app's head.
93
96
 
97
+ ```html
98
+ <link
99
+ href="https://fonts.googleapis.com/css?family=Nunito+Sans:300,300i,400,400i,600,600i,700,700i,800,800i,900,900i&display=swap"
100
+ rel="stylesheet"
101
+ />
94
102
  ```
95
103
 
96
- ## Tutorial
97
-
98
- We have created a tutorial to guide you in creating an awesome app with Innovaccer Design System components. Please find it [here](/docs/AppTutorial.md).
104
+ **👉 Updating Font:**
99
105
 
106
+ If you don't add the font described above font family will not be affected by css. However, if you want to update the font family update it via the following css variable.
100
107
 
101
- ## How to run locally?
108
+ ```css
109
+ --font-family
110
+ ```
102
111
 
103
- ```bash
104
- #clone repository
105
- git clone https://github.com/innovaccer/design-system.git
112
+ **👉 Reset Styles**
106
113
 
107
- #install dependencies
108
- npm install
114
+ As BEM is used reset.css is not used and no style reset is done.
109
115
 
110
- #start development server
111
- npm run dev
112
- ```
116
+ **👉 Polyfill for IE**
113
117
 
118
+ For css variables to work on IE we use a polyfill at runtime to achieve dynamic theming through variables. Please add the following polyfill in your page.
114
119
 
115
- ## Documentation
120
+ ```html
121
+ <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
122
+ <script>
123
+ cssVars({
124
+ onlyLegacy: true,
125
+ });
126
+ </script>
127
+ ```
116
128
 
117
- **[Design](http://design.innovaccer.com)**
129
+ ## :books: Documentation
118
130
 
119
- **[Components](https://innovaccer.github.io/design-system)**
131
+ - [🌶 Masala Design System](http://design.innovaccer.com)
120
132
 
133
+ - [📗 Components Storybook](https://innovaccer.github.io/design-system)
121
134
 
122
135
  ## ❗ Code of Conduct
123
136
 
124
- We expect everyone participating in the community to abide by our [**Code of Conduct**](https://github.com/innovaccer/design-system/blob/master/CODE_OF_CONDUCT.md). Please read it. Please follow it. We work hard to build each other up and create amazing things together. 💪💜
137
+ We expect everyone participating in the community to abide by our [**Code of Conduct**](https://github.com/innovaccer/design-system/blob/master/CODE_OF_CONDUCT.md). Please read it. Please follow it. We work hard to build each other up and create amazing things together. 💪💜
125
138
 
126
139
  ## 🤝 How to Contribute
127
140
 
@@ -129,18 +142,54 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
129
142
 
130
143
  Check out our [**Contributing Guide**](https://github.com/innovaccer/design-system/blob/master/CONTRIBUTING.md) for ideas on contributing and setup steps for getting our repositories up and running on your local machine.
131
144
 
132
- ### A note on how this repository is organized
133
-
134
- This repository is codebase for all and we publish it to NPM as package.
135
-
136
- ### Contributing
137
-
138
- We are currently only accepting bug fixes.
145
+ ## Contributors
146
+
147
+ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
148
+
149
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
150
+ <!-- prettier-ignore-start -->
151
+ <!-- markdownlint-disable -->
152
+ <table>
153
+ <tr>
154
+ <td align="center"><a href="https://github.com/aditya-kumawat"><img src="https://avatars.githubusercontent.com/u/12715487?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aditya Kumawat</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=aditya-kumawat" title="Code">💻</a></td>
155
+ <td align="center"><a href="https://riyalohia.github.io/portfolio/"><img src="https://avatars.githubusercontent.com/u/31706090?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Riya Lohia</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=riyalohia" title="Code">💻</a></td>
156
+ <td align="center"><a href="http://satyamyadav.info/"><img src="https://avatars.githubusercontent.com/u/3583587?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Satyam Yadav</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=satyamyadav" title="Code">💻</a> <a href="https://github.com/innovaccer/design-system/commits?author=satyamyadav" title="Documentation">📖</a> <a href="https://github.com/innovaccer/design-system/pulls?q=is%3Apr+reviewed-by%3Asatyamyadav" title="Reviewed Pull Requests">👀</a></td>
157
+ <td align="center"><a href="https://github.com/sandeshchoudhary"><img src="https://avatars.githubusercontent.com/u/11272274?v=4?s=100" width="100px;" alt=""/><br /><sub><b>sandeshchoudhary</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=sandeshchoudhary" title="Code">💻</a></td>
158
+ <td align="center"><a href="https://github.com/adityajhajharia"><img src="https://avatars.githubusercontent.com/u/42600089?v=4?s=100" width="100px;" alt=""/><br /><sub><b>adityajhajharia</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=adityajhajharia" title="Code">💻</a></td>
159
+ <td align="center"><a href="https://github.com/anuradha9712"><img src="https://avatars.githubusercontent.com/u/46045493?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Anuradha Aggarwal</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=anuradha9712" title="Code">💻</a></td>
160
+ <td align="center"><a href="https://github.com/xlreon"><img src="https://avatars.githubusercontent.com/u/26788670?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sidharth</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=xlreon" title="Code">💻</a></td>
161
+ </tr>
162
+ <tr>
163
+ <td align="center"><a href="https://github.com/stuti1090"><img src="https://avatars.githubusercontent.com/u/65341865?v=4?s=100" width="100px;" alt=""/><br /><sub><b>stuti1090</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=stuti1090" title="Code">💻</a></td>
164
+ <td align="center"><a href="https://github.com/veekays"><img src="https://avatars.githubusercontent.com/u/6420348?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vikas Singh</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=veekays" title="Code">💻</a></td>
165
+ <td align="center"><a href="https://github.com/SaniyaGupta"><img src="https://avatars.githubusercontent.com/u/15903031?v=4?s=100" width="100px;" alt=""/><br /><sub><b>SaniyaGupta</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=SaniyaGupta" title="Code">💻</a></td>
166
+ <td align="center"><a href="https://www.linkedin.com/in/parth-chauhan-984624193/"><img src="https://avatars.githubusercontent.com/u/35137224?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Parth Chauhan</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=chauhanparth210" title="Code">💻</a></td>
167
+ <td align="center"><a href="https://github.com/stutirao"><img src="https://avatars.githubusercontent.com/u/45294592?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Stuti Pandey</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=stutirao" title="Code">💻</a></td>
168
+ <td align="center"><a href="https://github.com/Shib00"><img src="https://avatars.githubusercontent.com/u/33096446?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Shivam Dwivedi</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=Shib00" title="Code">💻</a></td>
169
+ <td align="center"><a href="http://www.rahulgaur.info/"><img src="https://avatars.githubusercontent.com/u/760474?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Rahul Gaur</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=aregee" title="Code">💻</a></td>
170
+ </tr>
171
+ <tr>
172
+ <td align="center"><a href="https://github.com/atifzaidi92"><img src="https://avatars.githubusercontent.com/u/54103064?v=4?s=100" width="100px;" alt=""/><br /><sub><b>atifzaidi92</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=atifzaidi92" title="Code">💻</a></td>
173
+ <td align="center"><a href="https://github.com/Sumit2399"><img src="https://avatars.githubusercontent.com/u/66456021?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sumit Dhyani</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=Sumit2399" title="Code">💻</a></td>
174
+ <td align="center"><a href="https://tanmay-portfolio.herokuapp.com/"><img src="https://avatars.githubusercontent.com/u/36269283?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tanmay Sharma</b></sub></a><br /><a href="https://github.com/innovaccer/design-system/commits?author=927tanmay" title="Code">💻</a></td>
175
+ </tr>
176
+ </table>
177
+
178
+ <!-- markdownlint-restore -->
179
+ <!-- prettier-ignore-end -->
180
+
181
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
182
+
183
+ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
184
+ <!-- prettier-ignore-start -->
185
+ <!-- markdownlint-disable -->
186
+ <!-- markdownlint-restore -->
187
+ <!-- prettier-ignore-end -->
188
+
189
+ <!-- ALL-CONTRIBUTORS-LIST:END -->
190
+
191
+ This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
139
192
 
140
193
  ## :memo: License
141
194
 
142
195
  Licensed under the [MIT License](https://github.com/innovaccer/design-system/blob/master/LICENSE).
143
-
144
- ## 💜 Thanks
145
-
146
- Thanks to our many contributors.