@cagovweb/state-template 1.0.0 → 1.1.0-beta.2

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 (19) hide show
  1. package/dist/css/cagov.core.css +4 -16
  2. package/dist/css/cagov.core.min.css +1 -1
  3. package/dist/js/cagov.core.js +496 -516
  4. package/dist/js/cagov.core.min.js +1 -1
  5. package/dist/readme.md +1 -1
  6. package/index.mjs +7 -0
  7. package/package.json +11 -6
  8. package/readme.md +64 -0
  9. package/README.md +0 -17
  10. package/dist/fonts/CaGov.svg +0 -528
  11. package/dist/fonts/CaGov.ttf +0 -0
  12. package/dist/fonts/CaGov.woff +0 -0
  13. package/dist/fonts/publicsans-bold-webfont.woff +0 -0
  14. package/dist/fonts/publicsans-extrabold-webfont.woff +0 -0
  15. package/dist/fonts/publicsans-extralight-webfont.woff +0 -0
  16. package/dist/fonts/publicsans-light-webfont.woff +0 -0
  17. package/dist/fonts/publicsans-medium-webfont.woff +0 -0
  18. package/dist/fonts/publicsans-regular-webfont.woff +0 -0
  19. package/dist/fonts/publicsans-semibold-webfont..woff +0 -0
package/dist/readme.md CHANGED
@@ -1,4 +1,4 @@
1
- State Template Source Verion 6.1.2
1
+ State Template Source Version 6.1.2
2
2
 
3
3
  You may use the CDN location instead of this folder
4
4
 
package/index.mjs ADDED
@@ -0,0 +1,7 @@
1
+ const error = () => {
2
+ throw new Error(
3
+ "Please import appropriate files separately. See Docs -> https://www.npmjs.com/package/@cagovweb/state-template"
4
+ );
5
+ };
6
+
7
+ export default { er: error() };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@cagovweb/state-template",
3
- "version": "1.0.0",
4
- "description": "CA State Web Template NPM Package",
3
+ "version": "1.1.0-beta.2",
4
+ "description": "California State Web Template NPM Package",
5
5
  "repository": {
6
6
  "type": "git",
7
7
  "url": "https://github.com/Office-of-Digital-Services/California-State-Web-Template-Development.git"
@@ -11,11 +11,15 @@
11
11
  "keywords": [
12
12
  "California",
13
13
  "State",
14
- "sacramento",
14
+ "Sacramento",
15
15
  "CA",
16
16
  "Government",
17
17
  "gov",
18
- "Template"
18
+ "Template",
19
+ "state-template",
20
+ "ca.gov",
21
+ "state of California",
22
+ "ca web template"
19
23
  ],
20
24
  "author": {
21
25
  "name": "Carter Medlin",
@@ -24,7 +28,7 @@
24
28
  },
25
29
  "publishConfig": {
26
30
  "access": "public",
27
- "tag": "beta"
31
+ "tags": "beta"
28
32
  },
29
33
  "scripts": {
30
34
  "NPM Publish (dry run)": "npm publish --dry-run",
@@ -34,5 +38,6 @@
34
38
  "postpack": "rm -rf ./dist"
35
39
  },
36
40
  "license": "MIT",
37
- "type": "commonjs"
41
+ "type": "module",
42
+ "main": "index.mjs"
38
43
  }
package/readme.md ADDED
@@ -0,0 +1,64 @@
1
+ # California State Web Template NPM Package
2
+
3
+ This is the NPM Package for the California State Web Template, an HTML template and website standard offered by the California Department of Technology to state agencies and departments within the State of California and beyond.
4
+
5
+ The California State Web Template is designed to promote a responsive and standard look and feel to ensure a uniform user experience across state entities. The web template includes many usability, security and accessibility requirements and is updated regularly to meet evolving industry standards and best practices.
6
+
7
+ The state web template is an open source project which you can find on the [CA Office of Digital Services GitHub repository](https://github.com/Office-of-Digital-Services). There are various technology versions of the web template available for consumption. Collaboration is highly encouraged and user feedback and contributions are always considered and often implemented.
8
+
9
+ This package is based on [Bootstrap v5.1.3](https://www.npmjs.com/package/bootstrap/v/5.1.3)
10
+
11
+ ## How to use
12
+
13
+ ### React
14
+
15
+ ```javascript
16
+ //Core CSS first
17
+ import "@cagovweb/state-template/dist/css/cagov.core.css";
18
+ //Choose Theme
19
+ import "@cagovweb/state-template/dist/css/colortheme-oceanside.css";
20
+ //Core JS last
21
+ import "@cagovweb/state-template/dist/js/cagov.core.js";
22
+ ```
23
+
24
+ ### Eleventy
25
+
26
+ **`.eleventy.js`** [(see reference)](https://www.11ty.dev/docs/copy/)
27
+
28
+ ```javascript
29
+ module.exports = function(eleventyConfig) {
30
+ // Copy state template core files to site output
31
+ eleventyConfig.addPassthroughCopy({
32
+ "node_modules/@cagovweb/state-template/dist": "state-template"
33
+ });
34
+ };
35
+ ```
36
+
37
+ At references in your template files
38
+
39
+ ```html
40
+ <head>
41
+ ...
42
+ <link rel="stylesheet" href="state-template/css/cagov.core.min.css"/>
43
+ <link rel="stylesheet" href="state-template/css/colortheme-oceanside.min.css"/>
44
+ <script type="text/javascript" src="state-template/js/cagov.core.min.js"></script>
45
+ </head>
46
+ ```
47
+
48
+ ## Documentation
49
+
50
+ For more information on how to use the state web template, please visit [webstandards.ca.gov](https://webstandards.ca.gov/template/). There you will find documentation on how to get started, how to customize the template, how to follow the web standards and best practices, and how to join the community of web developers and designers working with the state web template.
51
+
52
+ You can also visit [template.webstandards.ca.gov](https://template.webstandards.ca.gov/) to see examples of websites built with the state web template and learn more about the upcoming design system that will replace the state web template in the future.
53
+
54
+ ## License
55
+
56
+ The state web template is licensed under the MIT License. See [LICENSE](https://github.com/Office-of-Digital-Services/California-State-Web-Template-Development/blob/main/LICENSE) for details.
57
+
58
+ ## Status
59
+
60
+ [![npm version](https://img.shields.io/npm/v/@cagovweb/state-template?logo=npm&logoColor=fff)](https://www.npmjs.com/package/@cagovweb/state-template)
61
+ [![template version](https://img.shields.io/github/package-json/v/Office-of-Digital-Services/California-State-Web-Template-Development?label=template&logo=github)](https://github.com/Office-of-Digital-Services/California-State-Web-Template-Development/blob/main/package.json)
62
+ [![license](https://img.shields.io/github/license/Office-of-Digital-Services/California-State-Web-Template-Development?logo=github)](https://github.com/Office-of-Digital-Services/California-State-Web-Template-Development/blob/main/publish/LICENSE)
63
+ [![CSS gzip size](https://img.badgesize.io/Office-of-Digital-Services/California-State-Web-Template-HTML/main/ca_state_template/css/cagov.core.min.css?compression=gzip&label=CSS%20gzip%20size)](https://github.com/Office-of-Digital-Services/California-State-Web-Template-HTML/blob/main/ca_state_template/css/cagov.core.min.css)
64
+ [![JS gzip size](https://img.badgesize.io/Office-of-Digital-Services/California-State-Web-Template-HTML/main/ca_state_template/js/cagov.core.min.js?compression=gzip&label=JS%20gzip%20size)](https://github.com/Office-of-Digital-Services/California-State-Web-Template-HTML/blob/main/ca_state_template/js/cagov.core.min.js)
package/README.md DELETED
@@ -1,17 +0,0 @@
1
- # California State Web Template Development
2
-
3
- This repository contains the development source code for the California State Web Template, an HTML template and website standard offered by the California Department of Technology to state agencies and departments within the State of California and beyond.
4
-
5
- The California State Web Template is designed to promote a responsive and standard look and feel to ensure a uniform user experience across state entities. The web template includes many usability, security and accessibility requirements and is updated regularly to meet evolving industry standards and best practices.
6
-
7
- The state web template is an open source project which you can find on the [CA Office of Digital Services GitHub repository](https://github.com/Office-of-Digital-Services). There are various technology versions of the web template available for consumption. Collaboration is highly encouraged and user feedback and contributions are always considered and often implemented.
8
-
9
- ## Documentation
10
-
11
- For more information on how to use the state web template, please visit [webstandards.ca.gov](https://webstandards.ca.gov/template/). There you will find documentation on how to get started, how to customize the template, how to follow the web standards and best practices, and how to join the community of web developers and designers working with the state web template.
12
-
13
- You can also visit [template.webstandards.ca.gov](https://template.webstandards.ca.gov/) to see examples of websites built with the state web template and learn more about the upcoming design system that will replace the state web template in the future.
14
-
15
- ## License
16
-
17
- The state web template is licensed under the MIT License. See [LICENSE](https://github.com/Office-of-Digital-Services/California-State-Web-Template-Development/blob/main/LICENSE) for details.