pallote-css 0.3.10 → 0.3.12

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 (61) hide show
  1. package/README.md +0 -144
  2. package/dist/pallote.min.css +1 -1
  3. package/dist/pallote.min.css.map +1 -1
  4. package/dist/pallote.scss +31 -36
  5. package/dist/styles/common/_editor.scss +29 -25
  6. package/dist/styles/common/_fontface.scss +7 -4
  7. package/dist/styles/common/_global.scss +25 -22
  8. package/dist/styles/common/_mixins.scss +19 -16
  9. package/dist/styles/common/_reset.scss +4 -2
  10. package/dist/styles/common/_variables.scss +28 -25
  11. package/dist/styles/components/_accordion.scss +16 -13
  12. package/dist/styles/components/_alert.scss +44 -40
  13. package/dist/styles/components/_breadcrumbs.scss +8 -5
  14. package/dist/styles/components/_button.scss +32 -26
  15. package/dist/styles/components/_buttons.scss +4 -2
  16. package/dist/styles/components/_card.scss +14 -11
  17. package/dist/styles/components/_divider.scss +3 -1
  18. package/dist/styles/components/_form.scss +4 -1
  19. package/dist/styles/components/_grid.scss +11 -8
  20. package/dist/styles/components/_input.scss +36 -32
  21. package/dist/styles/components/_link.scss +7 -4
  22. package/dist/styles/components/_list.scss +2 -0
  23. package/dist/styles/components/_nav.scss +49 -45
  24. package/dist/styles/components/_navbar.scss +42 -39
  25. package/dist/styles/components/_section.scss +35 -31
  26. package/dist/styles/components/_sidebar.scss +20 -16
  27. package/dist/styles/components/_snippet.scss +25 -22
  28. package/dist/styles/components/_status.scss +8 -5
  29. package/dist/styles/components/_switch.scss +11 -8
  30. package/dist/styles/components/_tabs.scss +18 -15
  31. package/dist/styles/components/_tag.scss +16 -12
  32. package/dist/styles/utilities/_color.scss +84 -81
  33. package/dist/styles/utilities/_global.scss +23 -20
  34. package/dist/styles/utilities/_text.scss +55 -51
  35. package/package.json +12 -8
  36. package/dist/assets/fonts/SourceSansPro/regular.woff2 +0 -0
  37. package/dist/assets/fonts/SourceSansPro/regularitalic.woff2 +0 -0
  38. package/dist/assets/fonts/SourceSansPro/semibold.woff2 +0 -0
  39. package/dist/assets/fonts/SourceSansPro/semibolditalic.woff2 +0 -0
  40. package/dist/assets/icons/logos/patreon.svg +0 -3
  41. package/dist/assets/icons/phosphor/arrow-right.svg +0 -1
  42. package/dist/assets/icons/phosphor/arrow-square-out.svg +0 -1
  43. package/dist/assets/icons/phosphor/caret-down.svg +0 -1
  44. package/dist/assets/icons/phosphor/check-circle.svg +0 -1
  45. package/dist/assets/icons/phosphor/check.svg +0 -1
  46. package/dist/assets/icons/phosphor/coffee.svg +0 -1
  47. package/dist/assets/icons/phosphor/download-simple.svg +0 -1
  48. package/dist/assets/icons/phosphor/envelope-simple.svg +0 -1
  49. package/dist/assets/icons/phosphor/files.svg +0 -1
  50. package/dist/assets/icons/phosphor/info.svg +0 -1
  51. package/dist/assets/icons/phosphor/warning.svg +0 -1
  52. package/dist/assets/icons/phosphor/x-circle.svg +0 -1
  53. package/dist/assets/icons/rabbit.svg +0 -1
  54. package/dist/scripts/accordion.js +0 -42
  55. package/dist/scripts/button.js +0 -5
  56. package/dist/scripts/cookie.js +0 -15
  57. package/dist/scripts/input.js +0 -18
  58. package/dist/scripts/nav.js +0 -22
  59. package/dist/scripts/navbar.js +0 -28
  60. package/dist/scripts/switch.js +0 -3
  61. package/dist/scripts/tabs.js +0 -30
package/README.md CHANGED
@@ -1,145 +1 @@
1
1
  # Pallote CSS
2
-
3
- Welcome to Pallote CSS! Pallote CSS is an open-source CSS library aimed at providing developers with a collection of reusable and customisable components and styles streamline the development of web projects.
4
-
5
- - [Usage](#usage)
6
- - [Documentation](#documentation)
7
- - [Contributing](#contributing)
8
- - [Methodology](#methodology)
9
- - [License](#license)
10
-
11
- ## Usage
12
-
13
- ### Installation
14
-
15
- #### NPM
16
-
17
- To install Pallote CSS via npm use:
18
-
19
- ```shell
20
- npm install pallote-css
21
- ```
22
-
23
- Then import the global style file in your SASS file, like this if you are using SASS:
24
-
25
- ```scss
26
- @import '../node_modules/pallote-css/dist/pallote.scss';
27
- ```
28
-
29
- Or if you are using regular CSS, locate the file, copy/paste them into your project and import them into you `<head>`.
30
-
31
- ```html
32
- <link rel="stylesheet" href="link/to/file/pallote.css">
33
- ```
34
-
35
- #### CDN
36
-
37
- Alternatively, you can link via a CDN. Simply copy/paste this code in between the `head` tag of your website. Make sure to add the version number, as next version could introduce breaking changes.
38
-
39
- ```html
40
- <link rel="stylesheet" href="https://cdn.jsdeliver.net/npm/pallote-css@1.0.0/dist/pallote.min.css">
41
- ```
42
-
43
- ### Using Components
44
-
45
- Once the library is imported, start using the components by adding appropriate class names to your HTML elements. Refer to the [documentation](https://pallote.com) for each component to understand its usage and available customisation options.
46
-
47
- ```html
48
- <button class="button button-primary">Primary Button</button>
49
- ```
50
-
51
- ### Customisation
52
-
53
- Pallote CSS allows for easy customisation of components to match your project's design.
54
-
55
- #### Custom variables
56
-
57
- The framework has a set of built-in variables that create the design look and feel. To override them, add a variable with the same name in your Sass style file. To see the full list of variables, see [documentation](https://pallote.com).
58
-
59
- ```scss
60
- $primary: #007A1E;
61
-
62
- @import '../node_modules/pallote-css/dist/pallote.scss';
63
- ```
64
-
65
- #### Custom components styles
66
-
67
- To change a component style, see the documentation for each component and add create an instance of the class with new properties in your style file.
68
-
69
- ```scss
70
- @import '../node_modules/pallote-css/dist/pallote.scss';
71
-
72
- .button {
73
- text-decoration: underline;
74
- }
75
- ```
76
-
77
- You can also override default styles by defining custom CSS rules in your project's stylesheet.
78
-
79
- ```css
80
- .custom-button {
81
- text-decoration: underline;
82
- }
83
- ```
84
-
85
- ## Documentation
86
-
87
- For detailed documentation on each component and customisation options, please refer to the documentation website: [pallote.com](https://pallote.com).
88
-
89
- The documentation is built with Jekyll. For more information on how to run the repo and contribute, see section below.
90
-
91
- ## Contributing
92
-
93
- Contributions are welcome! If you find any bugs or have suggestions for new features, feel free to open an issue or submit a pull request. This documentation serves as a guide for contributors on how to effectively contribute to the project.
94
-
95
- ### Run the project locally
96
-
97
- - Fork the repository and clone it
98
- - Install [Jekyll](https://jekyllrb.com/); Jekyll is a Ruby Gem that can be installed on most systems ([installation manual](https://jekyllrb.com/docs/installation/)).
99
- - Install dependencies
100
-
101
- ```shell
102
- npm install
103
- ```
104
-
105
- - Start a localhost server
106
-
107
- ```shell
108
- npm run dev
109
- ```
110
-
111
- ### Make changes
112
-
113
- - Checkout to `develop` branch
114
- - Create a new branch on which to write your code
115
-
116
- ```shell
117
- git checkout -b feature-name-of-branch
118
- ```
119
-
120
- > Make sure to add the prefix `feature-` to the name of your branch
121
-
122
- - Write your code. There are two locations for the style files:
123
- - `dist/styles` folder, which are the core styles of the library
124
- - `assets/styles` folder, which are the documentation specific styles
125
-
126
- > You don't need to run any additional command to compile sass files, it does it automatically with `npm run dev`
127
- > Remember to add any new class or property to the doc
128
-
129
- ### Submit your code
130
-
131
- - Before submitting a pull request, make sure to test your changes thoroughly. Ensure that your changes do not break any existing functionality and that they are compatible with different browsers.
132
- - Once the changes are made and tested, submit a pull request to the main repository. Be sure to include a clear description of all the changes you've made.
133
- - When changes are approved, they will be merged into the develop branch for testing, and will be published to the master branch on the next release.
134
-
135
- ### Reporting Issues
136
-
137
- If you encounter any issues while using Pallote CSS, please report them by opening an issue on the GitHub repository. Be sure to include a detailed description of the problem and steps to reproduce it.
138
-
139
- ## Methodology
140
-
141
- Pallote CSS is based on an adapted version of BEM terminology (for Block Element Modifier). More information on naming conventions and methodology is in progress.
142
-
143
- ## License
144
-
145
- This project is licensed under the MIT License - see the LICENSE file for details.