@ipscape/mammatus
v0.0.1-alpha.21
Published
[![NPM version](https://img.shields.io/npm/v/@ipscape/mammatus.svg?style=flat)](https://npmjs.org/package/@ipscape/mammatus) [![NPM downloads](https://img.shields.io/npm/dm/@ipscape/mammatus.svg?style=flat)](https://npmjs.org/package/@ipscape/mammatus)
Downloads
194
Readme
@ipscape/mammatus
Mammatus is designed to facilitate the sharing of Vue components across various applications, including
Workspace
,Agent-Toolbar
, andCTI
. This enables reusing components, streamlining the development process across platforms with different Vue versions or even outside the Vue ecosystem.
Features
- Works in Workspace [no vue app]
- Works in AT [vue2]
- Works in CTI [vue3]
Installation
pnpm install @ipscape/mammatus
Usage
Check available builds inside /dist
.
Here's a quick example to get you started:
import '@ipscape/mammatus/vue2/style.css';
import { NewPasswordInput } from '@ipscape/mammatus/vue2';
// Example usage
<NewPasswordInput v-model="passwordModelRef" />
API Reference
- components/
Single components with no context of views
- views/
Group of components with expected behaviour to be shared between apps
Limitations (when working in this library)
- Vue features need to be limit to
[email protected]
composition api so we can be retrocompatible with old versions of Vue.- Example: New macro defineModel won't work since was introduced in
[email protected]+
.
- Example: New macro defineModel won't work since was introduced in
- This library depends on
@ipscape/cumulus
which needs to be installed in vue applications, which leads to some discrepancies.- Example:
AT
uses the old version of cumulus andCTI
uses the new version of cumulus, which leads to some discrepancies, such asips-input
having an@focus
event in the new version of cumulus but not in the old version.
- Example:
How to publish
cd packages/mammatus
pnpm build-npm
# bump packages/mammatus/package.json version
npm publish
How to test locally
- todo
License
@ipscape/mammatus is licensed under the ISC License.