@pacem/pacem 1.0.0-ampere → 1.0.0-aristotle
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.
- package/README.md +87 -0
- package/dist/browser/pacem-2d.js +1 -1
- package/dist/browser/pacem-2d.min.js +1 -1
- package/dist/browser/pacem-3d.js +1 -1
- package/dist/browser/pacem-3d.min.js +1 -1
- package/dist/browser/pacem-charts.js +1 -1
- package/dist/browser/pacem-charts.min.js +1 -1
- package/dist/browser/pacem-cms.js +1 -1
- package/dist/browser/pacem-cms.min.js +1 -1
- package/dist/browser/pacem-core.js +1 -1
- package/dist/browser/pacem-core.min.js +1 -1
- package/dist/browser/pacem-foundation.js +1 -1
- package/dist/browser/pacem-foundation.min.js +1 -1
- package/dist/browser/pacem-fx.js +1 -1
- package/dist/browser/pacem-fx.min.js +1 -1
- package/dist/browser/pacem-logging.js +1 -1
- package/dist/browser/pacem-logging.min.js +1 -1
- package/dist/browser/pacem-maps.js +1 -1
- package/dist/browser/pacem-maps.min.js +1 -1
- package/dist/browser/pacem-media.js +1 -1
- package/dist/browser/pacem-media.min.js +1 -1
- package/dist/browser/pacem-networking.js +1 -1
- package/dist/browser/pacem-networking.min.js +1 -1
- package/dist/browser/pacem-numerical.js +1 -1
- package/dist/browser/pacem-numerical.min.js +1 -1
- package/dist/browser/pacem-plus.js +1 -1
- package/dist/browser/pacem-plus.min.js +1 -1
- package/dist/browser/pacem-scaffolding.js +1 -1
- package/dist/browser/pacem-scaffolding.min.js +1 -1
- package/dist/browser/pacem-ui.js +1 -1
- package/dist/browser/pacem-ui.min.js +1 -1
- package/dist/bundle/pacem.min.mjs +326 -325
- package/dist/bundle/pacem.mjs +5603 -5164
- package/dist/bundle/pacem.mjs.map +4 -4
- package/dist/typings/index.d.ts +828 -52
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
[](https://www.npmjs.com/package/@pacem/pacem)
|
|
2
|
+
[](https://github.com/pacem-it/pacem/blob/main/LICENSE)
|
|
3
|
+
|
|
4
|
+
 @pacem/pacem
|
|
5
|
+
========
|
|
6
|
+
|
|
7
|
+
[Pacem JS](https://js.pacem.it) is a [CustomElements-v1](https://www.w3.org/TR/custom-elements/) based ecosystem for reusable web components.
|
|
8
|
+
|
|
9
|
+
`@pacem/pacem` is the all-in-one **bundle package**: it re-exports every individual `@pacem/pacem-*` package under a single install, and ships pre-built browser bundles, an ESM bundle, rolled-up TypeScript typings, and an HTML editor IntelliSense data file. If you only need one or two capabilities (e.g. just `ui` and `core`), you can depend on those scoped packages directly instead — this package is the convenience wrapper around all of them.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```sh
|
|
14
|
+
npm install @pacem/pacem
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
### As an ES module
|
|
20
|
+
|
|
21
|
+
```js
|
|
22
|
+
import { Components } from '@pacem/pacem';
|
|
23
|
+
|
|
24
|
+
// custom element classes, grouped by originating package
|
|
25
|
+
const { PacemIconElement } = Components.UI;
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Each capability is namespaced under its own export, so nothing collides even though every underlying package registers `pacem-*` custom elements globally as a side effect of being imported:
|
|
29
|
+
|
|
30
|
+
| Export | Package |
|
|
31
|
+
|---|---|
|
|
32
|
+
| `Foundation` | `@pacem/pacem-foundation` |
|
|
33
|
+
| `Numerical` | `@pacem/pacem-numerical` |
|
|
34
|
+
| `Core` | `@pacem/pacem-core` |
|
|
35
|
+
| `UI` | `@pacem/pacem-ui` |
|
|
36
|
+
| `TwoD` | `@pacem/pacem-2d` |
|
|
37
|
+
| `ThreeD` | `@pacem/pacem-3d` |
|
|
38
|
+
| `Scaffolding` | `@pacem/pacem-scaffolding` |
|
|
39
|
+
| `Charts` | `@pacem/pacem-charts` |
|
|
40
|
+
| `Maps` | `@pacem/pacem-maps` |
|
|
41
|
+
| `Cms` | `@pacem/pacem-cms` |
|
|
42
|
+
| `Fx` | `@pacem/pacem-fx` |
|
|
43
|
+
| `Media` | `@pacem/pacem-media` |
|
|
44
|
+
| `Networking` | `@pacem/pacem-networking` |
|
|
45
|
+
| `Plus` | `@pacem/pacem-plus` |
|
|
46
|
+
| `Logging` | `@pacem/pacem-logging` |
|
|
47
|
+
| `Components` | every custom element class, merged from all of the above |
|
|
48
|
+
| `L10n` | localization helpers (from `scaffolding` and `plus`) |
|
|
49
|
+
| `OpenApi` | OpenAPI/Swagger helpers (from `scaffolding` and `cms`) |
|
|
50
|
+
|
|
51
|
+
### In the browser, without a bundler
|
|
52
|
+
|
|
53
|
+
Each package also ships a self-contained, minified script under `dist/browser/` that extends a shared `window.Pacem` global — just include the ones you need:
|
|
54
|
+
|
|
55
|
+
```html
|
|
56
|
+
<script src="node_modules/@pacem/pacem/dist/browser/pacem-foundation.min.js"></script>
|
|
57
|
+
<script src="node_modules/@pacem/pacem/dist/browser/pacem-core.min.js"></script>
|
|
58
|
+
<script src="node_modules/@pacem/pacem/dist/browser/pacem-ui.min.js"></script>
|
|
59
|
+
|
|
60
|
+
<pacem-icon icon="star"></pacem-icon>
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### TypeScript
|
|
64
|
+
|
|
65
|
+
Typings are resolved automatically (`types`/`exports.types` point at `dist/typings/index.d.ts`), covering both the ES module import style and the ambient `Pacem` global used by the plain `<script>` include above:
|
|
66
|
+
|
|
67
|
+
```ts
|
|
68
|
+
import { UI } from '@pacem/pacem';
|
|
69
|
+
|
|
70
|
+
let el: UI.PacemIconElement; // via the module
|
|
71
|
+
let el2: Pacem.PacemIconElement; // via the ambient global, no import needed
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### HTML IntelliSense
|
|
75
|
+
|
|
76
|
+
`dist/vscode.html-custom.json` describes every `<pacem-*>` custom element and its attributes in the [VS Code HTML custom-data format](https://github.com/microsoft/vscode-html-languageservice#custom-data), including which `@pacem/pacem-*` package each one comes from. Point VS Code at it to get tag/attribute completion while editing markup:
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
// .vscode/settings.json
|
|
80
|
+
{
|
|
81
|
+
"html.customData": ["./node_modules/@pacem/pacem/dist/vscode.html-custom.json"]
|
|
82
|
+
}
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
[Apache-2.0](https://github.com/pacem-it/pacem/blob/main/LICENSE) © [Pacem](https://pacem.it)
|
package/dist/browser/pacem-2d.js
CHANGED
package/dist/browser/pacem-3d.js
CHANGED
package/dist/browser/pacem-fx.js
CHANGED
package/dist/browser/pacem-ui.js
CHANGED