Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@atelier-wb/vite-plugin-atelier
Advanced tools
Helps you buildind Component Driven UIs with Atelier and Vite
Readme
Weclome to the Atelier!
This Vite plugin launches atelier as part of your dev server.
It can also export your entire atelier as a static website.
You'll need first to write some "tools" files for your UI components.
Please refer to your UI framework binding API:
Then, assuming you already installed vite and configured it,
install the plugin for Vite and your UI framework bindings,
npm i -D @atelier-wb/vite-plugin-atelier @atelier-wb/[your-ui-framework]
register the plugin in vite.config.js
file:
// other vite plugins
import atelier from '@atelier-wb/vite-plugin-atelier'
export default defineConfig({
plugins: [/* other plugins */ atelier({ framework: 'your-ui-framework' })]
})
start vite in dev mode:
npx vite
then browse your components on http://localhost:3000/atelier.
To export your atelier, run Vite build command with export-atelier
mode:
vite build --mode export-atelier
The atelier plugin function takes the following settings:
framework
(detaults to svelte
): your UI framework of choice. To this day, only Svelte is supported.url
(detaults to /atelier/
): the url root under which Atelier's UI will be available. Must have leading and trailing /
.path
(defaults to ./atelier
): the path to the top level folder containing your *.tools.*
files. It could be either absolute, or relative to your vite configuration file.toolRegexp
(defaults to /\.tools(?!\.shot$).+$/
, any files endinf with .tools.
but .tools.shot
): the regular expression used to find your tool files.outDir
(defaults to ./dist-atelier
): path to the folder which will contain the static export of your atelier.setupPath
: optional path to a file imported prior to any of your tool files. It can be absolute, from node_modules, or relative to path
.publicDir
: optional path, or list of paths, to folders containing static assets your tools may use.For example:
atelier({
framework: 'svelte',
url: '/atelier/',
toolRegexp: '\\.tools\\.svelte$',
path: './tests', // cwd()/tests/**/*.tools.svelte
setupPath: './atelier-setup.js' // cwd()/tests/atelier-setup.js
})
FAQs
Helps you buildind Component Driven UIs with Atelier and Vite
The npm package @atelier-wb/vite-plugin-atelier receives a total of 0 weekly downloads. As such, @atelier-wb/vite-plugin-atelier popularity was classified as not popular.
We found that @atelier-wb/vite-plugin-atelier demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.