Files

T

andrewwallacespeckle 677b8202fa feat(fe2): workspace slug / short id support (#3088 )

* Add edit slug dialog

* Design changes to edit button

* Slug url implementation

* Disable slug edit if non admin

* Preloading queries

* Use preloaded workspace id

* Changes pre PR

* Removed unneeded import

* feat(workspaces): migrate slug to match the workspaceId

* WIP Comments

* Add watch. Use Fragment

* Tidy create

* Tidy ups

* Tidy up Edit Dialog

* Remove comment

* Update text - changing slug does not break embeds

* Updates from CR

* Reorder ProjectList

* Feedback from Michal

---------

Co-authored-by: Gergő Jedlicska <gergo@jedlicska.com>

2024-10-01 16:23:54 +01:00

.storybook

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

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

src

feat(fe2): workspace slug / short id support (#3088 )

2024-10-01 16:23:54 +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

fix(viewer): viewer node16 support + fixing up package.jsons (#2442 )

2024-07-15 15:16:13 +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