@wwtdev/bsds-components-vue3 3.0.20 → 3.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -28,8 +28,8 @@ import '@wwtdev/bsds-icons-vue3/lib/style.css' // see note below re ^2.0.6
28
28
 
29
29
  #### Migration from v1
30
30
  1. Remove the `@wwtdev/bsds-components` package, as this Vue 3 package no longer depends on a base web component library.
31
- 2. This package no longer provides or requires a Vue plugin, so remove any imports / logic related to that.
32
- 3. These components no longer render custom element tags (e.g., `<bs-input-field>` is now `<div data-component="bs-input-field">`), so if you have any CSS rules or DOM-related logic that relied on the previous version's custom element tag selectors, you'll need to update those accordingly.
31
+ 2. This package no longer provides or requires a Vue plugin, so remove any imports / logic related to that.
32
+ 3. These components no longer render custom element tags (e.g., `<bs-input-field>` is now `<div data-component="bs-input-field">`), so if you have any CSS rules or DOM-related logic that relied on the previous version's custom element tag selectors, you'll need to update those accordingly.
33
33
 
34
34
 
35
35
  ### Nuxt App Setup
@@ -68,7 +68,7 @@ If you're using Tailwind in your project, you'll need to take additional steps a
68
68
 
69
69
  ### 1. Add the WWT Preset to the Tailwind config.
70
70
 
71
- For new projects, we recommend that you use the provided config file as a [**preset**](https://tailwindcss.com/docs/presets). When setting up the `tailwind.config.js` file, import the WWT preset from the CSS Framework package. Note that `wwt-bsds-preset.js` sets `config.corePlugins.preflight: false` by default; we do this to apply our style resets instead of the Tailwind resets.
71
+ For new projects, we recommend that you use the provided config file as a [**preset**](https://tailwindcss.com/docs/presets). When setting up the `tailwind.config.js` file, import the WWT preset from the CSS Framework package. Note that `wwt-bsds-preset.js` sets `config.corePlugins.preflight: false` by default; we do this to apply our style resets instead of the Tailwind resets.
72
72
 
73
73
  ```javascript
74
74
  /* tailwind.config.js */
@@ -104,7 +104,7 @@ Since our CSS has its own reset and default styles, we prevent Tailwind's `base`
104
104
  @tailwind utilities;
105
105
  ```
106
106
 
107
- Once you have completed the Tailwind installation steps, you can use the classes generated from the preset.
107
+ Once you have completed the Tailwind installation steps, you can use the classes generated from the preset.
108
108
 
109
109
  ### 3. App setup w/ Tailwind and BSDS Styles
110
110
 
@@ -140,7 +140,7 @@ export default defineNuxtConfig({
140
140
 
141
141
  #### Using CSS Layers with Tailwind
142
142
 
143
- You can optionally leverage native CSS `@layer` to ensure TW utilities will always trump the component styles for easier overrides.
143
+ You can optionally leverage native CSS `@layer` to ensure TW utilities will always trump the component styles for easier overrides.
144
144
 
145
145
  ```css
146
146
  /* src/styles/index.css (or wherever your app styles live) */
@@ -153,7 +153,7 @@ You can optionally leverage native CSS `@layer` to ensure TW utilities will alwa
153
153
  /* -- EXTERNAL: any external stylesheets, e.g. from other 3d party libs -- */
154
154
  @import "some-other-pkg/dist/style.css" layer(external);
155
155
 
156
- /* -- APP / INTERNAL STYLES, e.g. your site's base styles --
156
+ /* -- APP / INTERNAL STYLES, e.g. your site's base styles --
157
157
  All .vue <style> code will automatically be added to this layer (see "vueWrapCssWithLayerPlugin" in vite.config.js)
158
158
  */
159
159
  @import "some-content.css" layer(app);
@@ -180,7 +180,7 @@ const vueWrapCssWithLayerPlugin = {
180
180
  transform(code, id) {
181
181
  // if not a .vue <style> block, do nothing
182
182
  if (!/vue&type=style/.test(id)) return
183
-
183
+
184
184
  // wrap the <style> code in our "app" css layer (ensures utility classes always trump other styles, see index.css)
185
185
  return { code: `@layer app { ${code} }`, map: null }
186
186
  }
@@ -188,7 +188,7 @@ const vueWrapCssWithLayerPlugin = {
188
188
 
189
189
  export default defineConfig({
190
190
  plugins: [ ...yourOtherPlugins, vueWrapCssWithLayerPlugin ],
191
- /*
191
+ /*
192
192
  *** other configs **
193
193
  */
194
194
  })
@@ -196,5 +196,5 @@ export default defineConfig({
196
196
 
197
197
  ### 4. Dark Mode-compatible "semantic" color utilities
198
198
 
199
- We've extended the TW theme with color utilities that will automatically adjust when using dark mode. These classes require the CSS custom properties defined in the global stylesheet (`wwt-bsds.css`). If you're not bringing that stylesheet in, either disregard these classes or manually include the properties from [tokens.css](https://github.wwt.com/custom-apps/wwt-blue-steel/blob/main/packages/css-framework/src/styles/tokens.css) and [global.css](https://github.wwt.com/custom-apps/wwt-blue-steel/blob/main/packages/css-framework/src/styles/global.css) in your project.
199
+ We've extended the TW theme with color utilities that will automatically adjust when using dark mode. These classes require the CSS custom properties defined in the global stylesheet (`wwt-bsds.css`). If you're not bringing that stylesheet in, either disregard these classes or manually include the properties from [tokens.css](https://github.com/wwt-custom-apps/wwt-blue-steel/blob/main/packages/css-framework/src/styles/tokens.css) and [global.css](https://github.com/wwt-custom-apps/wwt-blue-steel/blob/main/packages/css-framework/src/styles/global.css) in your project.
200
200