ava-styleguide

styleguide

npm install ava-styleguide

Thanks for all the downloads, but we're just using this to push some components and Bootstrap overrides downstream to multiple projects, in an attempt to get design system consistency. For this reason it had to be public. This approach will change and is probably not useful to anyone outside our company, so sorry.

bootstrap will be added along with override file

(New Project Only) Create a new scss file named "styleguide.scss" in the root directory

Add an import to styleguide.scss

@import './node_modules/ava-styleguide/styleguide.scss';

(New Project Only) Add the scss script to package.json file in main project

"scss": "sass override.scss compiled-bootstrap/override-bootstrap.css"

npm run scss

a new folder named compiled-bootstrap with a file named override-bootstrap.css will populate at root of project

(New Project Only) add imports to main.js order is important

import 'bootstrap'
import 'bootstrap/dist/css/bootstrap.min.css'
import '../compiled-bootstrap/override-bootstrap.css'

after any updates are made to the package here, then do this in the app repo which uses this:

npm update --save ava-styleguide
npm run scss

API Usage

ListApiPlugin

in main.js file:

import listApiPlugin from 'ava-styleguide/js/plugin/ListApiPlugin.js'

const listConfigs = [
	{ envVariable: import.meta.env.VITE_APP_LISTS_BASE_URL, listName: '<list name here>'}
]

app.use(listApiPlugin, listConfigs)

In your component

methods: {
	async getData() {
		const listApi = this.$listApis['<above listname in listConfigs here>']
		const response = await listApi.getAll()
		console.log(response.d.results)
	}
}

Use in Pinia store

in your main.js file after app.use(listApiPlugin, listConfigs)

export const listApi = app.config.globalProperties.$listApis['<listName from listConfigs>']

in your pinia store

import { listApi } from '../main.js'

call it in a function/actions

const response = await listApi.getAll()

UserApiPlugin

in main.js file:

import userApiPlugin from 'ava-styleguide/js/plugin/UserApiPlugin.js'

const userConfigs = [
	{ envVariable: import.meta.env.VITE_APP_USER_BASE_URL, key: '<unique key name here>'}
]

app.use(userApiPlugin, userConfigs)

In your component

methods: {
	async getUserData() {
		const userApi = this.$userApis['<above key in userConfigs here>']
		const response = await userApi.getCurrentUser()
		console.log(response.d)
	}
}

Use in Pinia store

in your main.js file after app.use(listApiPlugin, listConfigs)

export const userApi = app.config.globalProperties.$userApis['<key from userConfigs>']

in your pinia store

import { userApi } from '../main.js'

call it in a function/actions

const response = await userApi.getCurrentUser()

LegacyUserApiPlugin

in main.js file:

import legacyUserApiPlugin from 'ava-styleguide/js/plugin/LegacyUserApiPlugin.js'

const legacyUserConfigs = [
	{ envVariable: process.env.VUE_APP_USER_BASE_URL, key: '<unique key name here>'}
]

app.use(legacyUserApiPlugin, legacyUserConfigs)

In your component

methods: {
	async getUserData() {
		const userApi = this.$legacyUserApis['<above key in userConfigs here>']
		const response = await userApi.getCurrentUser()
		console.log(response.d)
	}
}

Use in Pinia store

in your main.js file after app.use(listApiPlugin, listConfigs)

export const legacyUserApi = app.config.globalProperties.$legacyUserApis['<key from legacyUserConfigs>']

in your pinia store

import { legacyUserApi } from '../main.js'

call it in a function/actions

const response = await legacyUserApi.getCurrentUser()

Update styleguide.scss

after adding the components or classes you want to populate in the styleguide -push changes to github

npm version <major, minor, patch>

you need a contributor npm account to run these, verify on https://www.npmjs.com/package/ava-styleguide/access ``sh npm publish

then push the new puiblished version to github again

(example patch push)

git push npm version patch npm publish git push