{"_id":"@aautcq/aautcq-ui","_rev":"1-97c05c9738b36f3b0a8e6b315d4bfa96","name":"@aautcq/aautcq-ui","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@aautcq/aautcq-ui","version":"0.1.0","author":{"name":"Adrien Autricque","email":"adrien.autricque@gmail.com"},"description":"VueJS components library","license":"MIT","main":"dist/aautcq-ui.umd.js","module":"dist/aautcq-ui.es.js","types":"dist/types/index.d.ts","typings":"dist/types/index.d.ts","publishConfig":{"access":"public"},"exports":{".":{"import":"./dist/aautcq-ui.es.js","require":"./dist/aautcq-ui.umd.js"}},"lint-staged":{"*.{js,ts,vue}":["pnpm run format:hook","pnpm run lint:hook"]},"engines":{"node":"^18.7.0","pnpm":"^8.6.0"},"cacheDirectories":["node_modules"],"repository":{"type":"git","url":"git+https://github.com/aautcq/aautcq-ui.git"},"bugs":{"url":"https://github.com/aautcq/aautcq-ui/issues"},"homepage":"https://github.com/aautcq/aautcq-ui#readme","peerDependencies":{"vue":"^3.3.4","vue-i18n":"^9.2.2","vue-router":"^4.2.0"},"devDependencies":{"@babel/core":"~7.23.0","@histoire/plugin-vue":"~0.17.1","@intlify/unplugin-vue-i18n":"~1.4.0","@aautcq/eslint-config":"~2.1.0","@aautcq/prettier-config":"~2.1.1","@aautcq/tailwind-config":"~2.1.3","@aautcq/web-utils":"~2.1.2","@iconify/vue":"~4.1.1","@tiptap/extension-blockquote":"~2.1.12","@tiptap/extension-bold":"~2.1.12","@tiptap/extension-bubble-menu":"~2.1.12","@tiptap/extension-bullet-list":"~2.1.12","@tiptap/extension-character-count":"~2.1.12","@tiptap/extension-code":"~2.1.12","@tiptap/extension-code-block":"~2.1.12","@tiptap/extension-color":"~2.1.12","@tiptap/extension-document":"~2.1.12","@tiptap/extension-dropcursor":"~2.1.12","@tiptap/extension-gapcursor":"~2.1.12","@tiptap/extension-hard-break":"~2.1.12","@tiptap/extension-heading":"~2.1.12","@tiptap/extension-highlight":"~2.1.12","@tiptap/extension-history":"~2.1.12","@tiptap/extension-horizontal-rule":"~2.1.12","@tiptap/extension-image":"~2.1.12","@tiptap/extension-italic":"~2.1.12","@tiptap/extension-link":"~2.1.12","@tiptap/extension-list-item":"~2.1.12","@tiptap/extension-mention":"~2.1.12","@tiptap/extension-ordered-list":"~2.1.12","@tiptap/extension-paragraph":"~2.1.12","@tiptap/extension-placeholder":"~2.1.12","@tiptap/extension-strike":"~2.1.12","@tiptap/extension-subscript":"~2.1.12","@tiptap/extension-superscript":"~2.1.12","@tiptap/extension-text":"~2.1.12","@tiptap/extension-text-align":"~2.1.12","@tiptap/extension-text-style":"~2.1.12","@tiptap/extension-typography":"~2.1.12","@tiptap/extension-underline":"~2.1.12","@tiptap/extension-youtube":"~2.1.12","@tiptap/vue-3":"~2.1.12","@types/google.maps":"~3.54.3","@types/intl-tel-input":"~18.1.0","@types/lodash":"~4.14.196","@types/node":"~20.8.4","@vitejs/plugin-vue":"~4.4.0","@vitest/coverage-v8":"~0.34.1","@vitest/ui":"~0.34.1","@vue/test-utils":"~2.3.2","@vuepic/vue-datepicker":"~7.1.0","cssnano":"~6.0.1","date-fns":"~2.30.0","histoire":"~0.17.2","husky":"~8.0.3","intl-tel-input":"~18.2.1","jsdom":"~22.1.0","lint-staged":"~14.0.1","lodash":"~4.17.21","npm-run-all":"~4.1.5","postcss-loader":"~7.3.3","rimraf":"~5.0.1","sass":"~1.69.2","tippy.js":"~6.3.7","typescript":"~5.2.2","vite":"~4.4.8","vite-plugin-css-injected-by-js":"~3.3.0","vite-plugin-dts":"~3.6.0","vite-plugin-eslint":"~1.8.1","vitest":"~0.34.1","vue-tsc":"~1.8.8","yup":"~1.3.2"},"keywords":["vue","vite","component","library","aautcq","histoire"],"scripts":{"preinstall":"npx only-allow pnpm","deps:clear":"rimraf node_modules package-lock.json yarn.lock pnpm-lock.yaml","deps:reset":"pnpm run deps:clear && pnpm install","build:clean":"rimraf dist","build:typescheck":"vue-tsc --noEmit","build:transpile":" vite build","build:pack":"pnpm run build:clean && pnpm run build:typescheck && pnpm run build:transpile && pnpm pack","deploy:check":"pnpm run lf:check && pnpm run test:check","deploy:run":"pnpm run deploy:check && pnpm run build:pack && pnpm publish","lint:hook":"eslint --fix --ignore-path .eslintignore","lint:check":"eslint --ignore-path .eslintignore --ext .ts,.vue src","lint:fix":"eslint --fix --ignore-path .eslintignore --ext .ts,.vue src","format:hook":"prettier --write --ignore-path .prettierignore --ignore-unknown","format:check":"prettier --check --ignore-path .prettierignore --ignore-unknown .","format:fix":"prettier --write --ignore-path .prettierignore --ignore-unknown .","lf:check":"pnpm run lint:check && pnpm run format:check","lf:fix":"pnpm run lint:fix && pnpm run format:fix","test:check":"rimraf src/tests/__snapshots__ && vitest run","test:ui":"rimraf src/tests/__snapshots__ && vitest --ui","test:coverage":"vitest run --coverage","docs:dev":"histoire dev","docs:clean":"rimraf .histoire","docs:transpile":"histoire build","docs:build":"pnpm-run-all docs:clean docs:transpile","docs:preview":"histoire preview"},"_id":"@aautcq/aautcq-ui@0.1.0","_integrity":"sha512-umg/O+NyoGFzgoMgD9/cveCZ3uVVaXoKNNoduFepLLcIwzw+nc3+m+bDeimbnYjOujVVumAK05rhsPBI8L8Euw==","_resolved":"/private/var/folders/ym/k72k0h6d0lndrm2wqg4kbjzc0000gn/T/1f635a4dd33f5b61aaacca86c87c2ac4/aautcq-aautcq-ui-0.1.0.tgz","_from":"file:aautcq-aautcq-ui-0.1.0.tgz","_nodeVersion":"18.7.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-umg/O+NyoGFzgoMgD9/cveCZ3uVVaXoKNNoduFepLLcIwzw+nc3+m+bDeimbnYjOujVVumAK05rhsPBI8L8Euw==","shasum":"2030f3f131c4b6c81025f8d6eee6d6f92621d279","tarball":"https://registry.npmjs.org/@aautcq/aautcq-ui/-/aautcq-ui-0.1.0.tgz","fileCount":66,"unpackedSize":3016992,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHX3PSJ+eDsV4kvRhOD5YDq3lZHpgQ6WWqP/oPA0t5dOAiAmSaWS5vKgwS8KPrQcj9vlyuSjzG7i28rojGx69zfivw=="}]},"_npmUser":{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"},"directories":{},"maintainers":[{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aautcq-ui_0.1.0_1697118469299_0.6267593025411631"},"_hasShrinkwrap":false},"0.1.1":{"name":"@aautcq/aautcq-ui","version":"0.1.1","author":{"name":"Adrien Autricque","email":"adrien.autricque@gmail.com"},"description":"VueJS components library","license":"MIT","main":"dist/aautcq-ui.umd.js","module":"dist/aautcq-ui.es.js","types":"dist/types/index.d.ts","typings":"dist/types/index.d.ts","publishConfig":{"access":"public"},"exports":{".":{"import":"./dist/aautcq-ui.es.js","require":"./dist/aautcq-ui.umd.js"}},"lint-staged":{"*.{js,ts,vue}":["pnpm run format:hook","pnpm run lint:hook"]},"engines":{"node":"^18.7.0","pnpm":"^8.6.0"},"cacheDirectories":["node_modules"],"repository":{"type":"git","url":"git+https://github.com/aautcq/aautcq-ui.git"},"bugs":{"url":"https://github.com/aautcq/aautcq-ui/issues"},"homepage":"https://github.com/aautcq/aautcq-ui#readme","peerDependencies":{"vue":"^3.3.4","vue-i18n":"^9.2.2","vue-router":"^4.2.0"},"devDependencies":{"@babel/core":"~7.23.0","@histoire/plugin-vue":"~0.17.1","@intlify/unplugin-vue-i18n":"~1.4.0","@aautcq/eslint-config":"~2.1.0","@aautcq/prettier-config":"~2.1.1","@aautcq/tailwind-config":"~2.1.3","@aautcq/web-utils":"~2.1.2","@iconify/vue":"~4.1.1","@tiptap/extension-blockquote":"~2.1.12","@tiptap/extension-bold":"~2.1.12","@tiptap/extension-bubble-menu":"~2.1.12","@tiptap/extension-bullet-list":"~2.1.12","@tiptap/extension-character-count":"~2.1.12","@tiptap/extension-code":"~2.1.12","@tiptap/extension-code-block":"~2.1.12","@tiptap/extension-color":"~2.1.12","@tiptap/extension-document":"~2.1.12","@tiptap/extension-dropcursor":"~2.1.12","@tiptap/extension-gapcursor":"~2.1.12","@tiptap/extension-hard-break":"~2.1.12","@tiptap/extension-heading":"~2.1.12","@tiptap/extension-highlight":"~2.1.12","@tiptap/extension-history":"~2.1.12","@tiptap/extension-horizontal-rule":"~2.1.12","@tiptap/extension-image":"~2.1.12","@tiptap/extension-italic":"~2.1.12","@tiptap/extension-link":"~2.1.12","@tiptap/extension-list-item":"~2.1.12","@tiptap/extension-mention":"~2.1.12","@tiptap/extension-ordered-list":"~2.1.12","@tiptap/extension-paragraph":"~2.1.12","@tiptap/extension-placeholder":"~2.1.12","@tiptap/extension-strike":"~2.1.12","@tiptap/extension-subscript":"~2.1.12","@tiptap/extension-superscript":"~2.1.12","@tiptap/extension-text":"~2.1.12","@tiptap/extension-text-align":"~2.1.12","@tiptap/extension-text-style":"~2.1.12","@tiptap/extension-typography":"~2.1.12","@tiptap/extension-underline":"~2.1.12","@tiptap/extension-youtube":"~2.1.12","@tiptap/vue-3":"~2.1.12","@types/google.maps":"~3.54.3","@types/intl-tel-input":"~18.1.0","@types/lodash":"~4.14.196","@types/node":"~20.8.4","@vitejs/plugin-vue":"~4.4.0","@vitest/coverage-v8":"~0.34.1","@vitest/ui":"~0.34.1","@vue/test-utils":"~2.3.2","@vuepic/vue-datepicker":"~7.1.0","cssnano":"~6.0.1","date-fns":"~2.30.0","histoire":"~0.17.2","husky":"~8.0.3","intl-tel-input":"~18.2.1","jsdom":"~22.1.0","lint-staged":"~14.0.1","lodash":"~4.17.21","npm-run-all":"~4.1.5","postcss-loader":"~7.3.3","rimraf":"~5.0.1","sass":"~1.69.2","tippy.js":"~6.3.7","typescript":"~5.2.2","vite":"~4.4.8","vite-plugin-css-injected-by-js":"~3.3.0","vite-plugin-dts":"~3.6.0","vite-plugin-eslint":"~1.8.1","vitest":"~0.34.1","vue-tsc":"~1.8.8","yup":"~1.3.2"},"keywords":["vue","vite","component","library","aautcq","histoire"],"scripts":{"preinstall":"npx only-allow pnpm","deps:clear":"rimraf node_modules package-lock.json yarn.lock pnpm-lock.yaml","deps:reset":"pnpm run deps:clear && pnpm install","build:clean":"rimraf dist","build:typescheck":"vue-tsc --noEmit","build:transpile":" vite build","build:pack":"pnpm run build:clean && pnpm run build:typescheck && pnpm run build:transpile && pnpm pack","deploy:check":"pnpm run lf:check && pnpm run test:check","deploy:run":"pnpm run deploy:check && pnpm run build:pack && pnpm publish","lint:hook":"eslint --fix --ignore-path .eslintignore","lint:check":"eslint --ignore-path .eslintignore --ext .ts,.vue src","lint:fix":"eslint --fix --ignore-path .eslintignore --ext .ts,.vue src","format:hook":"prettier --write --ignore-path .prettierignore --ignore-unknown","format:check":"prettier --check --ignore-path .prettierignore --ignore-unknown .","format:fix":"prettier --write --ignore-path .prettierignore --ignore-unknown .","lf:check":"pnpm run lint:check && pnpm run format:check","lf:fix":"pnpm run lint:fix && pnpm run format:fix","test:check":"rimraf src/tests/__snapshots__ && vitest run","test:ui":"rimraf src/tests/__snapshots__ && vitest --ui","test:coverage":"vitest run --coverage","docs:dev":"histoire dev","docs:clean":"rimraf .histoire","docs:transpile":"histoire build","docs:build":"pnpm-run-all docs:clean docs:transpile","docs:preview":"histoire preview"},"_id":"@aautcq/aautcq-ui@0.1.1","_integrity":"sha512-OoIN/hTnPepeOjf8jvPQ5VM+7xGBXFLMT6e83RgF+pG2nqIOlopTtMlLbdT+KtFSBiv1JZ4pwrh0tPErIzUzcA==","_resolved":"/private/var/folders/ym/k72k0h6d0lndrm2wqg4kbjzc0000gn/T/6a466a29aec573aeead9d85db90c5ebd/aautcq-aautcq-ui-0.1.1.tgz","_from":"file:aautcq-aautcq-ui-0.1.1.tgz","_nodeVersion":"18.7.0","_npmVersion":"8.15.0","dist":{"integrity":"sha512-OoIN/hTnPepeOjf8jvPQ5VM+7xGBXFLMT6e83RgF+pG2nqIOlopTtMlLbdT+KtFSBiv1JZ4pwrh0tPErIzUzcA==","shasum":"dd4f5e7e4c38879e3f6a4fcf4fe41bb1ea47d131","tarball":"https://registry.npmjs.org/@aautcq/aautcq-ui/-/aautcq-ui-0.1.1.tgz","fileCount":66,"unpackedSize":3018090,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCkg5vGSdhrjGYc8QQeRLKbR4yFKhrYO4jKwcp7gET68QIgDZbhmwtTQkcTcqz4waKi3Nmrr6r8W2IjHhIH1Pd6l6Y="}]},"_npmUser":{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"},"directories":{},"maintainers":[{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aautcq-ui_0.1.1_1697128426735_0.25490814989187105"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-12T13:47:49.210Z","0.1.0":"2023-10-12T13:47:49.666Z","modified":"2023-10-12T16:33:47.286Z","0.1.1":"2023-10-12T16:33:47.072Z"},"maintainers":[{"name":"adrien-autcq","email":"adrien.autricque@gmail.com"}],"description":"VueJS components library","homepage":"https://github.com/aautcq/aautcq-ui#readme","keywords":["vue","vite","component","library","aautcq","histoire"],"repository":{"type":"git","url":"git+https://github.com/aautcq/aautcq-ui.git"},"author":{"name":"Adrien Autricque","email":"adrien.autricque@gmail.com"},"bugs":{"url":"https://github.com/aautcq/aautcq-ui/issues"},"license":"MIT","readme":"# AautcqUI\n\n_AautcqUI_ is a Vue 3 components library.\n\n## Prerequisites\n\nYou will need the following things properly installed on your computer.\n\n- [Node.js](http://nodejs.org/) (with NPM)\n\n## Install & config\n\n### With NPM\n\n```bash\n$ npm i @aautcq/aautcq-ui\n```\n\n### Global components registration\n\nIn your Vue project, you can either register all components globally\n\n```js\nimport App from '@/App.vue';\nimport { createApp } from 'vue';\nimport createAautcqUi from '@aautcq/aautcq-ui';\n\nconst app = createApp(App);\n\nconst AautcqUI = createAautcqUi({\n  // options object\n});\n\napp.use(AautcqUI).mount('#app');\n```\n\n### On the fly import\n\nYou can also import components one at a time\n\n```vue\n<template>\n  <aa-button>Hello world</aa-button>\n</template>\n\n<script setup lang=\"ts\">\nimport { AaButton } from '@aautcq/aautcq-ui';\n</script>\n```\n\n**Important:** if you choose this method, you must manually initialize the Filestack service using `initFilestack` (documentation below).\n\n### Options\n\nThe `createAautcqUi` method takes an options object as parameter. Below are the keys of this object, which can be used to customize you usage of _AautcqUI_.\n\n- **`components`** - `Array<String>`\n\nThe array of component names to be globally registered. If not set, all components will be registered.\n\n- **`locale`** - `String`\n\nLocale to use for component wordings. Available locales are `'fr'` and `'en'`.\n\n### Composables\n\n- **Focus trap**\n\nThis composable creates a focus trap: the focus cannot go outside of the specified HTML element.\n\n```vue\n<template>\n  <div>\n    <div ref=\"trapRef\">Everything in here can be focused!</div>\n    <div>Cannot be focused</div>\n  </div>\n</template>\n\n<script setup lang=\"ts\">\nimport { useFocusTrap } from '@/composables/useFocusTrap';\n\nconst { trapRef } = useFocusTrap();\n</script>\n```\n\n### Exposed methods\n\n- **Modals**\n\nTo toggle modals built using the `Modal.vue` component, you can use the `toggle` exposed method.\n\n```vue\n<template>\n  <aa-modal ref=\"myModal\" name=\"my-modal\">I am a modal!</aa-modal>\n\n  <button type=\"button\" @click=\"myModal.toggle()\">Toggle modal</button>\n</template>\n\n<script setup lang=\"ts\">\nimport { ref } from 'vue';\n\nconst myModal = ref(null);\n</script>\n```\n\nAlternatively, you can use the global `toggleModal` method.\n\n```vue\n<template>\n  <aa-modal name=\"my-modal\">I am a modal!</aa-modal>\n\n  <button type=\"button\" @click=\"toggleModal('my-modal')\">Toggle modal</button>\n</template>\n\n<script setup lang=\"ts\">\nimport { ref } from 'vue';\nimport { toggleModal } from '@aautcq/aautcq-ui';\n</script>\n```\n\n- **Locale**\n\nIf you chose to import components on the fly (see above for more details), you might need to manually initialize the locale using the `setLocale` method.\n\nIn your `main.js` file:\n\n```js\nimport { setLocale } from '@aautcq/aautcq-ui';\n\nconst locale = 'fr';\nsetLocale(locale);\n```\n\nThe accepted locale is the same as the `options.locale` string used in the `createAautcqUi` method.\n\n## Build the library\n\nKindly ask another developper for the content of the `.env` file, then run\n\n```bash\n$ npm run build\n```\n\n## Run the documentation locally\n\nTo run the documentation locally, run\n\n```bash\n$ npm run docs:dev\n```\n\n## Further Reading / Useful Links\n\n- [Vue 3](https://vuejs.org/guide/introduction.html)\n- [Tailwind](https://tailwindcss.com/docs/installation)\n- [Sass](https://sass-lang.com/documentation)\n- [Histoire](https://histoire.dev/guide/vue3/getting-started.html)\n- [TypeScript](https://www.typescriptlang.org/docs/handbook/)\n- [Vite](https://vitejs.dev/guide/)\n","readmeFilename":"README.md"}