@esri/calcite-app-components
Advanced tools
A collection of web components for building single-page applications.
A collection of calcite components for building single page applications.
npm install --save @esri/calcite-app-components
calcite-app-components can be loaded via two <script> tags in the head of your HTML document:
<script type="module" src="<path-to-calcite-app-components-package>/dist/calcite-app/calcite-app.esm.js"></script>
<script nomodule="" src="<path-to-calcite-app-components-package>/dist/calcite-app/calcite-app.js"></script>
Browsers that support modules will load the first, while older browsers will load the second, bundled version. It's worth noting that only components that are actually used will be loaded.
You will also need to add a <link> tag for the shared component styles:
<link rel="stylesheet" href="<path-to-calcite-app-components-package>/dist/calcite-app/calcite-app.css" />
Once these tags are added, components can be used just like any other HTML element.
If you already have a webpack build for your project, you can simply use @stencil/webpack to add calcite-app-components to your bundle.
After installing calcite-app-components, install the plugin as a dev dependency:
npm install --save-dev @stencil/webpack
Then import and add the plugin in webpack.config.js:
const stencil = require('@stencil/webpack');
module.exports = {
...
plugins: [
new stencil.StencilPlugin()
]
}
Lastly, add the import in your main bundle js (or ts) file:
import '@esri/calcite-app-components/dist/calcite-app.js';
This will add the initial Stencil loader to your bundle, and copy over the actual component code to the output directory you've configured for Webpack. Components will still be lazy-loaded as they are needed. Note: you must use the .js file path for the Webpack plugin to work correctly, even if your bundle file is a TypeScript file.
Stencil provides a full set of typings for all the components in this repo. To make TypeScript aware of these components, just import the library:
import '@esri/calcite-app-components';
This will provide autocomplete of component names/properties, as well as additional HTML element types.
npm version <patch | minor | major>.
Follow semantic versioning. Patch for bug fixes only. Major for breaking changes. Minor for the rest.CHANGELOG.md.CHANGELOG.md is reviewed and everything looks OK, you can publish to NPM by running npm run release.*Aside: It will also update the docs for GitHub Pages and the READMEs for each component.
NOTE: This will happen automatically whenever there's a release. Follow steps below for manual docs update.
$ npm run docs.master branch before they take effect.Find a bug or want to request a new feature? Please let us know by submitting an issue.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
Copyright 2019 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's license.txt file.
4.9.0 (2019-12-10)
FAQs
A collection of web components for building single-page applications.
The npm package @esri/calcite-app-components receives a total of 49 weekly downloads. As such, @esri/calcite-app-components popularity was classified as not popular.
We found that @esri/calcite-app-components demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 38 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.