npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

jskos-vue

v0.3.16

Published

A suite of components and plugins for Vue 3 related to JSKOS

Downloads

117

Readme

jskos-vue

Test and build GitHub package version NPM package name standard-readme compliant

A suite of components and plugins for Vue 3 related to JSKOS.

Note that this is still under development and breaking changes can occur at any time!

Documentation

Please refer to the documentation on how to install and use jskos-vue in your project.

  • Stable (main): https://gbv.github.io/jskos-vue/
  • Development (dev): https://gbv.github.io/jskos-vue/dev/

Development

Please work on the dev branch during development (or better yet, develop in a feature branch and merge into dev when ready).

git clone https://github.com/gbv/jskos-vue.git
cd jskos-vue
npm install

We are using VitePress for documentation as well as component development as it includes live reloading of Vue components as well.

Development server on port 4311 (http://localhost:4311/):

npm run docs:dev

Each of the component as well as each utility method has its own documentation file in docs/components/ and docs/utilities/ respectively. Those files include practical examples which also function as a way to develop a component. In each file, you can have one <script setup> block that initializes the Vue/JS part of the page. Any variables defined in that block will be available to use in the template. You can use components and other Vue template structures right in the Markdown file. You can also define a <style> block if necessary. Note that this only works because VitePress handles these blocks separately from the rest of the Markdown content!

You should include the components via a relative path and you can also include any dependencies like you normally would:

<script setup>
import { ItemDetails } from "../../src/components"
import * as jskos from "jskos-tools"
import { reactive } from "vue"
// ...
</script>

For the code block that shows users how to replicate the example, please replace import { ItemDetails } from "../../src/components" with import { ItemDetails } from "jskos-vue". Also, the template part of the example needs to be enclosed in a <template> tag (only in the code block!) so that it is possible to copy-paste the example into a SFC .vue file.

Note that VitePress is still in beta and there are sometimes weird issues still. For instance, at one point in our examples, it wasn't possible to use @click to define a click handler and we had to use v-on:click instead, even though in other files, @click works just fine. Just keep this in mind in case you ever encounter weird error messages.

Documentation build:

npm run docs:build # documentation build
BASE=/dist/ npm run docs:build # documentation build with base path

The documentation build will be in docs/.vitepress/dist/.

Library browser build:

npm run build

The browser build files will be in dist/.

Maintainers

Publish

When a new release is ready (i.e. the features are finished, merged into dev, and all tests succeed), run the included release script (replace "patch" with "minor" or "major" if necessary):

npm run release:patch

This will:

  • Check that we are on dev
  • Run tests and build to make sure everything works
  • Make sure dev is up-to-date
  • Run npm version patch (or "minor"/"major")
  • Push changes to dev
  • Switch to main
  • Merge changes from dev
  • Push main with tags
  • Switch back to dev

After running this, GitHub Actions will automatically publish the new version to npm. It will also create a new GitHub Release draft. Please edit and publish the release draft manually.

License

MIT Copyright (c) 2021 Verbundzentrale des GBV (VZG)