Files

T

andrewwallacespeckle 2d184a0b59 FE2 - User Feedback Request - Menu item and Callout Banner (#1907 )

* Add Feedback Banner & Dialog

* Add Menu Item for Feedback

* New Nav Style & tidy up

* Feedback improvements

* FE2 Fixes. WIP Description

* Reorder Options. Fix cookie expiry

* Cookie update

* New function to handle cookie expiry dates. Update feedback dates.

* Change getFutureDateByMonths to getFutureDateByDays

* Updates to Feedback

* Instructional Animation Component

* Add select-none

* Fix storybook issue

* Changes from CR

* Dynamic Slots in Animation Component

* Update FE2 to use modified animation component

* Fix typing issue

* Changes from CR

2024-01-04 14:18:39 +00:00

.storybook

fix(fe2): reverting vue/nuxt downgrade (#1776 )

2023-08-29 09:52:48 +03:00

src

FE2 - User Feedback Request - Menu item and Callout Banner (#1907 )

2024-01-04 14:18:39 +00:00

utils

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

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

.eslintrc.cjs

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

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(fe2): upgrade to nuxt 3.8.2 (#1887 )

2023-11-29 10:22:17 +02:00

postcss.config.js

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

2023-05-16 13:43:04 +03: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

chore(fe2): upgrade to nuxt 3.8.2 (#1887 )

2023-11-29 10:22:17 +02: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