diff --git a/docs/components/card-catalog.md b/docs/components/card-catalog.md index 02309b0f61..45d735d64f 100644 --- a/docs/components/card-catalog.md +++ b/docs/components/card-catalog.md @@ -1,5 +1,14 @@ # Card Catalog +:::tip Note +The `KCardCatalog` component requires the [`@vue/composition-api`](https://github.com/vuejs/composition-api) package as a `peerDependency`. You must **manually** add the package to your host project by running the following + +``` shell +yarn add @vue/composition-api +``` + +::: + **KCardCatalog** - A grid view of KCards @@ -88,7 +97,7 @@ See [the State section](#loading) about `isLoading` ### fetcher Use a custom fetcher function to fetch card catalog items and leverage server-side pagination. -::: tip Note: +::: tip Note All fetcher functions should take a single param. This parameter is a JSON object supporting the following properties: @@ -97,7 +106,7 @@ object supporting the following properties: - `pageSize`: the number of items to display per page ::: -::: tip Note: +::: tip Note All fetcher functions should return a JSON object. This JSON object should contain the following properties: - `total` - the total count of catalog items (if using pagination) @@ -175,7 +184,7 @@ Set this to `true` to limit pagination navigation to `previous` / `next` page on ```vue ``` diff --git a/docs/components/table.md b/docs/components/table.md index 053f1ed9de..355611d41d 100644 --- a/docs/components/table.md +++ b/docs/components/table.md @@ -3,6 +3,15 @@ pageClass: table-docs --- # Table +:::tip Note +The `KTable` component requires the [`@vue/composition-api`](https://github.com/vuejs/composition-api) package as a `peerDependency`. You must **manually** add the package to your host project by running the following + +``` shell +yarn add @vue/composition-api +``` + +::: + Pass a fetcher function to build a slot-able table. ```vue @@ -93,7 +102,7 @@ This functionality may be flaky. Use a custom fetcher function to fetch table data and leverage server-side search, sort and pagination. -::: tip Note: +::: tip Note All fetcher functions should take a single param. This parameter is a JSON object supporting the following properties: @@ -107,7 +116,7 @@ object supporting the following properties: - `query`: a text string to filter table data on ::: -::: tip Note: +::: tip Note All fetcher functions should return a JSON object. This JSON object should contain the following properties: - `total` - the total count of items (if using pagination) @@ -211,8 +220,8 @@ object these features should be explicitly disabled. } }" :headers="[ - { label: 'Title', key: 'title', sortable: true }, - { label: 'Description', key: 'description', sortable: true }, + { label: 'Name', key: 'name', sortable: true }, + { label: 'Id', key: 'id', sortable: true }, { label: 'Enabled', key: 'enabled', sortable: false } ]" disablePagination diff --git a/package.json b/package.json index 6232c0df85..b40bb1e3d2 100644 --- a/package.json +++ b/package.json @@ -16,9 +16,11 @@ "scripts": { "build": "yarn build:styles && yarn build:utils && yarn docs:build && yarn build:cli", "build:postcss": "postcss packages/styles/styles.css --dir packages/styles", - "build:cli": "lerna exec --ignore @kongponents/styles --ignore @kongponents/utils \"ln -f ../../vue.config.js ./vue.config.js && ln -f ../../postcss-custom-properties.config.js ./postcss.config.js && yarn vue-cli-service build --target lib ./\\$(cat package.json | jq -r .source) --name \\$(cat package.json | jq -r .componentName) --dest dist && rm ./vue.config.js ./postcss.config.js\"", + "build:cli": "yarn create:package-configs && lerna exec --ignore @kongponents/styles --ignore @kongponents/utils \"yarn vue-cli-service build --target lib ./\\$(cat package.json | jq -r .source) --name \\$(cat package.json | jq -r .componentName) --dest ./dist\" && yarn delete:package-configs", "build:styles": "yarn node-sass packages/styles/styles.scss -o packages/styles && yarn build:postcss", "build:utils": "yarn vue-cli-service build --target lib --name utils --entry ./packages/utils/utils.js --dest ./packages/utils/dist && rm ./packages/utils/dist/demo.html", + "create:package-configs": "lerna exec --ignore @kongponents/styles --ignore @kongponents/utils \"ln -f ../../vue.config.js ./vue.config.js && ln -f ../../postcss-custom-properties.config.js ./postcss.config.js && ln -f ../../tailwind-custom-properties.config.js ./tailwind.config.js\"", + "delete:package-configs": "lerna exec --ignore @kongponents/styles --ignore @kongponents/utils \"rm -f ./vue.config.js ./postcss.config.js ./tailwind.config.js\"", "docs:dev": "yarn build:styles && vuepress dev docs", "docs:build": "vuepress build docs", "publish:ci": "lerna publish --conventional-commits --yes --force-publish", diff --git a/packages/KCardCatalog/package.json b/packages/KCardCatalog/package.json index edd30840d7..33986e7e23 100644 --- a/packages/KCardCatalog/package.json +++ b/packages/KCardCatalog/package.json @@ -29,8 +29,9 @@ "@kongponents/kemptystate": "^6.1.16", "@kongponents/kpagination": "^6.1.16", "@kongponents/kskeleton": "^6.1.16", - "@kongponents/utils": "^6.1.16", - "@vue/composition-api": "^1.2.4", - "vue": "2.6.10" + "@kongponents/utils": "^6.1.16" + }, + "peerDependencies": { + "@vue/composition-api": "^1.2.4" } } diff --git a/packages/KTable/package.json b/packages/KTable/package.json index f8af73cbca..d5ab50439f 100644 --- a/packages/KTable/package.json +++ b/packages/KTable/package.json @@ -29,8 +29,9 @@ "@kongponents/kpagination": "^6.1.16", "@kongponents/kskeleton": "^6.1.16", "@kongponents/utils": "^6.1.16", - "@vue/composition-api": "^1.2.4", - "vue": "2.6.10", "vue-uuid": "^2.0.2" + }, + "peerDependencies": { + "@vue/composition-api": "^1.2.4" } } diff --git a/packages/utils/package.json b/packages/utils/package.json index 788c84c9ea..e7afd890c1 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -17,8 +17,10 @@ "access": "public" }, "dependencies": { - "@vue/composition-api": "^1.2.4", "swrv": "0.9.4", "vue": "2.6.10" + }, + "peerDependencies": { + "@vue/composition-api": "^1.2.4" } } diff --git a/tailwind-custom-properties.config.js b/tailwind-custom-properties.config.js new file mode 100644 index 0000000000..a415f4b808 --- /dev/null +++ b/tailwind-custom-properties.config.js @@ -0,0 +1,17 @@ +module.exports = { + purge: [ + './**/*.vue' + ], + theme: { + extend: { + screens: { + '2xl': '1390px' + }, + maxWidth: { + 'screen-2xl': '1390px' + } + } + }, + variants: {}, + plugins: [] +}