Files

T

andrewwallacespeckle d12e80035d fix(fe2): keyboard shortcuts in viewer don't work (#2389 )

* feat: use shift for shortcuts. Swap onKeyStroke for useMagicKeys

* refactor: simplify control shortcuts

* Revert changes to input.ts

* refactor: Make more DRY

* Revert "refactor: Make more DRY"

This reverts commit a508fcfb9d2fef0cd2635911bc57410989166a50.

* Revert "Revert changes to input.ts"

This reverts commit c47300d0104d09f9fa0ae9bc9e86e994f0a46206.

* Revert "refactor: simplify control shortcuts"

This reverts commit a867d6e34d06a7a6436ff4bdb6c4a7db94d3ca21.

* Fix broken space

* Refactor Viewer Controls and Keyboard Shortcuts

* Fix keyboard shortcut mapping to handle string keys correctly

* refactor: string enum

* remove filters shortcut

2024-07-10 11:11:20 +01:00

.storybook

chore: updating ws everywhere to resolve SNYK-JS-WS-7266574 (#2385 )

2024-06-18 13:26:01 +03:00

src

fix(fe2): keyboard shortcuts in viewer don't work (#2389 )

2024-07-10 11:11:20 +01:00

utils

feat: tailwind theme & Vue base components extracted to own NPM packages (#1576 )

2023-05-16 13:43:04 +03:00

.npmignore

feat: tailwind theme & Vue base components extracted to own NPM packages (#1576 )

2023-05-16 13:43:04 +03:00

eslint.config.mjs

chore: upgrade to eslint 9 (#2348 )

2024-06-12 14:38:02 +03:00

index.html

feat: tailwind theme & Vue base components extracted to own NPM packages (#1576 )

2023-05-16 13:43:04 +03:00

package.json

chore: updating ws everywhere to resolve SNYK-JS-WS-7266574 (#2385 )

2024-06-18 13:26:01 +03:00

postcss.config.js

feat(fe2): app authorization workflow redesign [WBX-217] (#2044 )

2024-02-23 16:50:07 +02:00

README.md

feat(ui-components): more new components (#1613 )

2023-06-13 09:33:10 +03:00

tailwind.config.cjs

Feature - FE2 - Developer Settings (#1822 )

2023-10-26 12:51:05 +01:00

tsconfig.json

feat(shared): modularized package & node16 support (#2336 )

2024-06-11 14:12:13 +03:00

tsconfig.node.json

feat: tailwind theme & Vue base components extracted to own NPM packages (#1576 )

2023-05-16 13:43:04 +03:00

vite.config.ts

Feature: FE2 - Project Webhooks Page (#1792 )

2023-09-26 15:41:29 +02:00

README.md

ui-components

Speckle UI component library built with Vue 3 and relying on the Speckle Tailwind theme.

Setup

Make sure you have @speckle/tailwind-theme installed and set up with Tailwind
Install @speckle/ui-components
In your tailwind config import tailwindContentEntry from @speckle/ui-components/tailwind-configure and invoke it in the contents field to ensure PurgeCSS is configured correctly. It requires the CJS require object as its only parameter. If it isn't available (in an ESM environment), you can use node's createRequire().
Import @speckle/ui-components/style.css in your app. If exports map isn't supported you can also import from @speckle/ui-components/dist/style.css

Usage in Nuxt v3

It's suggested that you also install the @speckle/ui-components-nuxt Nuxt module. It will ensure that all of the Vue components can be auto-imported like components in nuxt's ./components directory. No need to import them manually anymore and you'll also get proper TS typing in your Vue templates out of the box!

Troubleshooting

Form validation doesn't work

It appears that in some scenarios Nuxt/Vite gets confused and bundles 'vee-validate' twice. To fix this add 'vee-validate' to vite.resolve.dedupe in your nuxt/vite config.

Build

Run yarn build

Development

Develop & test your components in Storybook - yarn storybook

Optionally you can also run yarn dev to run the Vite dev server which runs App.vue and in some special scenarios you might want to debug components there.

Troubleshooting

Styles don't work

Re-start storybook, it could be that you introduced a new tailwind class that was previously purged out