{"_id":"@digital-terrain/digital-terrain-ui-library","_rev":"2-1ff79ef6568d04f4357c4ec54a751858","name":"@digital-terrain/digital-terrain-ui-library","dist-tags":{"latest":"2.9.2"},"versions":{"2.9.2":{"name":"@digital-terrain/digital-terrain-ui-library","version":"2.9.2","author":{"name":"Blake Simpson"},"license":"ISC","_id":"@digital-terrain/digital-terrain-ui-library@2.9.2","maintainers":[{"name":"damiensutton","email":"damien@tickdone.com.au"},{"name":"troy.grey","email":"troy.grey@digitalterrain.io"}],"dist":{"shasum":"ac52d0ef66793ab9c03f3c9a748041036a343cef","tarball":"https://registry.npmjs.org/@digital-terrain/digital-terrain-ui-library/-/digital-terrain-ui-library-2.9.2.tgz","fileCount":515,"integrity":"sha512-cz1sGyI5zN/nqScEtZidyUB2o/Ar3eq/HLwxKgPg3lISc7t095HESxLLpHl8F9mVSadpIQFAsbz7mDw8c9Y1ww==","signatures":[{"sig":"MEYCIQDURrfc5Jf0NYRv/q1vOX6itGr1rP00Mcp26f8/lmRaogIhAPqHNpXTRhpPr4QDcQ8T5VnRt3/2drdPjfBiB5OO1H+5","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":4855901},"main":"index.js","gitHead":"e4cf0ec9042d197ea9afad8520018ed25eac88cb","scripts":{"complib:dev":"npm run dev --workspace=@digital-terrain/digital-terrain-ui-library","complib:build":"npm run build --workspace=@digital-terrain/digital-terrain-ui-library","storybook:docs":"npm run storybook:docs --workspace=digital-terrain-ui-library-storybook","complib:publish":"npm run complib:publish --workspace=@digital-terrain/digital-terrain-ui-library","storybook:build":"npm run build-storybook --workspace=digital-terrain-ui-library-storybook","storybook:start":"npm run storybook --workspace=digital-terrain-ui-library-storybook","complib:preserve":"npm run preserve --workspace=@digital-terrain/digital-terrain-ui-library","complib:typecheck":"npm run typecheck --workspace=@digital-terrain/digital-terrain-ui-library"},"_npmUser":{"name":"troy.grey","email":"troy.grey@digitalterrain.io"},"repository":{"url":"https://InsigTechnologies@dev.azure.com/InsigTechnologies/Insig%20UI%20Library/_git/digital-terrain-ui-library","type":"git"},"workspaces":["packages/complib","packages/storybook"],"_npmVersion":"6.14.16","description":"Digital Terrain UI Library monorepo","directories":{},"_nodeVersion":"12.22.12","dependencies":{"vue":"^3.2.41","sass":"^1.44.0","vite":"^3.2.4","luxon":"^1.28.0","core-js":"^3.19.2","vue-tsc":"^1.0.24","chart.js":"^3.9.1","primevue":"^3.10.0","lodash-es":"^4.17.21","primeflex":"^2.0.0","simplebar":"^5.3.6","primeicons":"^5.0.0","typescript":"^4.3.5","vue-router":"^4.0.12","@types/node":"^16.11.12","vue-fontawesome":"^0.0.2","vite-plugin-vue-layouts":"^0.7.0","@fortawesome/pro-light-svg-icons":"^5.15.4","@fortawesome/pro-solid-svg-icons":"^5.15.4","@fortawesome/fontawesome-svg-core":"^1.2.36","@fortawesome/pro-regular-svg-icons":"^5.15.4","@fortawesome/fontawesome-common-types":"^0.3.0"},"_hasShrinkwrap":false,"devDependencies":{"esbuild":"^0.15.12","@types/luxon":"^2.0.8"},"_npmOperationalInternal":{"tmp":"tmp/digital-terrain-ui-library_2.9.2_1697066000293_0.00690695280521858","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-10-11T23:13:20.292Z","modified":"2024-09-06T02:59:19.706Z","2.9.2":"2023-10-11T23:13:20.641Z"},"author":{"name":"Blake Simpson"},"license":"ISC","repository":{"url":"https://InsigTechnologies@dev.azure.com/InsigTechnologies/Insig%20UI%20Library/_git/digital-terrain-ui-library","type":"git"},"description":"Digital Terrain UI Library monorepo","maintainers":[{"email":"Jason.Mortlock@digitalterrain.io","name":"jmortlock-dt"},{"email":"damien@tickdone.com.au","name":"damiensutton"},{"email":"troy.grey@digitalterrain.io","name":"troy.grey"}],"readme":"# Insig UI Library\r\n\r\n> This Component Library is a collection of Vue UI components for use in the development of Insig applications\r\n> It was built with the intention of hastening development times, enabling reusability and to provide clarity for compositional decisions\r\n\r\n## Prerequisites\r\n\r\nThis project requires NodeJS (16.3.0 or later) and NPM (7.15.1 or later)\r\n\r\nTo make sure you have these versions available on your machine, try running the following command\r\n\r\n```sh\r\n$ npm -v && node -v\r\n7.15.1\r\nv16.3.0\r\n```\r\n\r\n## Table of contents\r\n\r\n- [Insig UI Library](#insig-ui-library)\r\n  - [Prerequisites](#prerequisites)\r\n  - [Table of contents](#table-of-contents)\r\n  - [Getting Started](#getting-started)\r\n  - [Installation](#installation)\r\n  - [Usage](#usage)\r\n    - [Serving the UI Library 'kitchen sink'](#serving-the-ui-library)\r\n    - [Building a package distribution version](#building-a-package-distribution-version)\r\n    - [Serving the distribution version](#serving-the-distribution-version)\r\n    - [Serving Storybook](#serving-storybook)\r\n    - [Building Storybook](#building-storybook)\r\n  - [Contributing](#contributing)\r\n    - [Tasklist](#tasklist)\r\n  - [Built With](#built-with)\r\n  - [Authors](#authors)\r\n  - [License](#license)\r\n\r\n## Getting Started\r\n\r\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system\r\n\r\n## Installation\r\n\r\n**BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites)\r\n\r\nStart with cloning this repo on your local machine:\r\n\r\n```sh\r\n$ git clone https://InsigTechnologies@dev.azure.com/InsigTechnologies/Insig%20UI%20Library/_git/insig-ui-library\r\n$ cd insig-ui-library\r\n```\r\n\r\nTo install and set up the library, run:\r\n\r\n```sh\r\n$ ./workspaces.install.sh\r\n```\r\n\r\n_Note_ If you have issues with workspaces, please ensure you are using the correct versions of NodeJS and NPM\r\n\r\n## Usage\r\n\r\n### Serving the UI Library 'kitchen sink'\r\n\r\n```sh\r\n$ npm run complib:dev\r\n```\r\n\r\n### Building a package distribution version\r\n\r\n```sh\r\n$ npm run complib:build\r\n```\r\n\r\n_Note_ If you have issues with TSC module not found, please blow away node_modules and perform a clean install\r\n\r\nThis task will create a distribution version of the project inside your local `packages/complib/dist/` folder\r\n\r\n### Publishing the distribution version\r\n\r\n_Note_ Before publishing please be sure to increment the version number correctly in `packages/complib/package.json`\r\n\r\n```sh\r\n$ npm run complib:publish\r\n```\r\n\r\n_Note_ If you have issues with NPM authentication please ensure your project contains a valid `.npmrc` file with a valid token\r\n\r\n_Note_ this requires\r\n[Building a package distribution version](#building-a-package-distribution-version) first\r\n\r\n### Serving Storybook\r\n\r\n```sh\r\n$ npm run storybook:start\r\n```\r\n\r\n### Building Storybook\r\n\r\n```\r\n$ npm run storybook:build\r\n```\r\n\r\n_Note_ You will most likely not need to run a manual build for Storybook as this should be managed by deployment pipelines\r\n\r\n## Contributing\r\n\r\nPlease see documentation within the Storybook instance related to contribution specifics\r\n\r\n1.  Fork it!\r\n2.  Create your feature branch: `git checkout -b my-new-feature`\r\n3.  Add your changes: `git add .`\r\n4.  Commit your changes: `git commit -m 'Add some feature'`\r\n5.  Push to the branch: `git push origin my-new-feature`\r\n6.  Submit a pull request :sunglasses:\r\n\r\n## Tasklist\r\n\r\n### Remaining Tasks\r\n\r\n- Create component: InsigActionsDataTableCell\r\n- any magic strings -> define and export (check classes for colors or other string params eg. buttonType, iconType etc.)\r\n- double check / update props in components for all optionals and defaults\r\n- double check / update all args in SB components to reflect final props\r\n- complete documentation for all components\r\n- complete documentation for all services\r\n\r\n### Component and Documentation Status\r\n\r\n| Component Name              | Integrated | Documented | Comment          |\r\n| --------------------------- | ---------- | ---------- | ---------------- |\r\n| font-awesome-icon           | **N/A**    | Yes        |                  |\r\n| Toast Service               | **N/A**    | Yes        |                  |\r\n| Confirm Dialog Service      | **N/A**    | Yes        |                  |\r\n| InsigApplication            | Yes        | Yes        |                  |\r\n| InsigAvatar                 | Yes        | Yes        |                  |\r\n| InsigBreadcrumb             | Yes        | Yes        |                  |\r\n| InsigButton                 | Yes        | Yes        |                  |\r\n| InsigButtonGroup            | Yes        | Yes        |                  |\r\n| InsigDataTable              | Yes        | Yes        |                  |\r\n| InsigDisplayField           | Yes        | Yes        |                  |\r\n| InsigEmptyDataTableCell     | Yes        | Yes        |                  |\r\n| InsigExpandablePanel        | Yes        | Yes        |                  | \r\n| InsigFieldset               | Yes        | Yes        |                  |\r\n| InsigFileUpload             | Yes        | Yes        |                  |\r\n| InsigInput                  | Yes        | Yes        |                  |\r\n| InsigInputAutoComplete      | Yes        | Yes        |                  |\r\n| InsigInputCalendar          | Yes        | Yes        |                  |\r\n| InsigInputCheckbox          | Yes        | Yes        |                  |\r\n| InsigInputDropdown          | Yes        | Yes        |                  |\r\n| InsigInputIncrement         | Yes        | Yes        |                  |\r\n| InsigInputMultiSelect       | Yes        | Yes        |                  |\r\n| InsigInputNumber            | Yes        | Yes        |                  |\r\n| InsigInputPassword          | Yes        | Yes        |                  |\r\n| InsigInputRadioButtonGroup  | Yes        | Yes        |                  |\r\n| InsigInputSwitch            | Yes        | Yes        |                  |\r\n| InsigInputTextArea          | Yes        | Yes        |                  |\r\n| InsigInputText              | Yes        | Yes        |                  |\r\n| InsigLayout                 | Yes        | Yes        |                  |\r\n| InsigLegend                 | Yes        | Yes        |                  |\r\n| InsigLogin                  | Yes        | **No**     | Not used for now |\r\n| InsigMenuBar                | Yes        | Yes        |                  |\r\n| InsigMenu                   | Yes        | Yes        |                  |\r\n| InsigMenuButton             | No         | No         | To do            |\r\n| InsigModal                  | Yes        | Yes        |                  |\r\n| InsigModalNotification      | Yes        | Yes        |                  |\r\n| InsigModalProgress          | Yes        | Yes        |                  |\r\n| InsigNotice                 | Yes        | Yes        |                  |\r\n| InsigPage                   | Yes        | Yes        |                  |\r\n| InsigPageNotAuthorized      | Yes        | Yes        |                  |\r\n| InsigPageNotFound           | Yes        | Yes        |                  |\r\n| InsigPanel                  | Yes        | Yes        |                  |\r\n| InsigPanelLoadError         | Yes        | Yes        |                  |\r\n| InsigPanelLoadProgress      | Yes        | Yes        |                  |\r\n| InsigProgressSpinner        | Yes        | Yes        |                  |\r\n| InsigRouterLink             | Yes        | Yes        |                  |\r\n| InsigSearchHeader           | Yes        | Yes        |                  |\r\n| InsigSelectButton           | Yes        | Yes        |                  |\r\n| InsigSideMenu               | Yes        | Yes        |                  |\r\n| InsigTabPanelHeader         | Yes        | Yes        |                  |\r\n| InsigTabView                | Yes        | Yes        |                  |\r\n| InsigTag                    | Yes        | Yes        |                  |\r\n| InsigTimeline               | Yes        | Yes        |                  |\r\n| InsigToolbarView            | Yes        | Yes        |                  |\r\n| InsigTree                   | Yes        | Yes        |                  |\r\n| InsigTreeTable              | Yes        | Yes        |                  |\r\n| InsigUserMenu               | Yes        | Yes        |                  |\r\n\r\n## Built With\r\n\r\n- Vue 3\r\n- Vite\r\n- NPM Workspaces\r\n- PrimeVue\r\n- Sass\r\n- Typescript\r\n\r\n## Authors\r\n\r\n- **Sam Barnett** - _Initial components work_\r\n- **Blake Simpson** - _Monorepo, packaging, components work and documentation_\r\n- **John Capt** - _Storybook components and documentation_\r\n- **Alyssa Booth** - _Storybook documentation_\r\n\r\n## License\r\n\r\n_TODO_ **Add license**\r\n","readmeFilename":"README.md"}