@kong/kongponents 9.28.1 → 9.28.2-pr.2684.3fe2fcabf.0

package/dist/types/components/KCodeBlock/KCodeBlock.vue.d.ts

@@ -1,273 +1,18 @@
-import type { PropType } from 'vue';
-import type { CodeBlockEventData, Theme } from '../../../types';
-type __VLS_Slots = {
-    /**
-     * Additional actions to be displayed in the code block.
-     */
-    'secondary-actions': void;
-};
-declare const __VLS_component: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    /**
-     * ID value used for form elements like the search input and its label.
-     */
-    id: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * The code that will be rendered as a text node inside of a `<pre><code></code></pre>` fragment.
-     */
-    code: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * The syntax language of `props.code` (e.g. `'json'`).
-     */
-    language: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * Whether filter mode is initially active. **Default: `false`**.
-     */
-    initialFilterMode: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Whether regular expression mode is initially active. **Default: `false`**.
-     */
-    initialRegExpMode: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Shows an actions bar with a search input and related action buttons. **Default: `false`**.
-     */
-    searchable: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * The line numbers for the lines to highlight by default. **Default: `[]`**.
-     */
-    highlightedLineNumbers: {
-        type: PropType<string | (number | [number, number])[]>;
-        default: () => never[];
-        validator: (value: string | (number | [number, number])[]) => boolean;
-    };
-    /**
-     * Allows controlling the processing state from outside the component. This allows a parent component to show the processing icon when it’s, for example, currently syntax highlighting the code. **Default: `false`**.
-     */
-    processing: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Used as the initial value of the search input. Can be used to initialize a code block with a query which was read from client storage. **Default: `''`**.
-     */
-    query: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-    /**
-     * Controls whether to show a copy button. It copies the original code (i.e. the value of `props.code`) to the clipboard. **Default: `true`**.
-     */
-    showCopyButton: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Controls whether to show line numbers. **Default: `true`**.
-     */
-    showLineNumbers: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Controls whether to add links to the current line number. **Default: `false`**.
-     */
-    showLineNumberLinks: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Controls the color scheme of the component. **Default: `light`**.
-     */
-    theme: {
-        type: PropType<Theme>;
-        required: false;
-        default: string;
-    };
-    /**
-     * Displays the code on a single line. **Default: `false`**.
-     */
-    singleLine: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * The max-height of the code block. **Default: `none`**.
-     */
-    maxHeight: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {} & {
-    "code-block-render": (data: CodeBlockEventData) => any;
-    "matching-lines-change": (data: CodeBlockEventData) => any;
-    "query-change": (data: string) => any;
-    "filter-mode-change": (data: boolean) => any;
-    "reg-exp-mode-change": (data: boolean) => any;
-}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    /**
-     * ID value used for form elements like the search input and its label.
-     */
-    id: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * The code that will be rendered as a text node inside of a `<pre><code></code></pre>` fragment.
-     */
-    code: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * The syntax language of `props.code` (e.g. `'json'`).
-     */
-    language: {
-        type: StringConstructor;
-        required: true;
-    };
-    /**
-     * Whether filter mode is initially active. **Default: `false`**.
-     */
-    initialFilterMode: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Whether regular expression mode is initially active. **Default: `false`**.
-     */
-    initialRegExpMode: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Shows an actions bar with a search input and related action buttons. **Default: `false`**.
-     */
-    searchable: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * The line numbers for the lines to highlight by default. **Default: `[]`**.
-     */
-    highlightedLineNumbers: {
-        type: PropType<string | (number | [number, number])[]>;
-        default: () => never[];
-        validator: (value: string | (number | [number, number])[]) => boolean;
-    };
-    /**
-     * Allows controlling the processing state from outside the component. This allows a parent component to show the processing icon when it’s, for example, currently syntax highlighting the code. **Default: `false`**.
-     */
-    processing: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Used as the initial value of the search input. Can be used to initialize a code block with a query which was read from client storage. **Default: `''`**.
-     */
-    query: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-    /**
-     * Controls whether to show a copy button. It copies the original code (i.e. the value of `props.code`) to the clipboard. **Default: `true`**.
-     */
-    showCopyButton: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Controls whether to show line numbers. **Default: `true`**.
-     */
-    showLineNumbers: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Controls whether to add links to the current line number. **Default: `false`**.
-     */
-    showLineNumberLinks: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * Controls the color scheme of the component. **Default: `light`**.
-     */
-    theme: {
-        type: PropType<Theme>;
-        required: false;
-        default: string;
-    };
-    /**
-     * Displays the code on a single line. **Default: `false`**.
-     */
-    singleLine: {
-        type: BooleanConstructor;
-        required: false;
-        default: boolean;
-    };
-    /**
-     * The max-height of the code block. **Default: `none`**.
-     */
-    maxHeight: {
-        type: StringConstructor;
-        required: false;
-        default: string;
-    };
-}>> & Readonly<{
-    "onCode-block-render"?: ((data: CodeBlockEventData) => any) | undefined;
-    "onMatching-lines-change"?: ((data: CodeBlockEventData) => any) | undefined;
-    "onQuery-change"?: ((data: string) => any) | undefined;
-    "onFilter-mode-change"?: ((data: boolean) => any) | undefined;
-    "onReg-exp-mode-change"?: ((data: boolean) => any) | undefined;
-}>, {
-    maxHeight: string;
-    theme: Theme;
-    initialFilterMode: boolean;
-    initialRegExpMode: boolean;
-    searchable: boolean;
-    highlightedLineNumbers: string | (number | [number, number])[];
-    processing: boolean;
-    query: string;
-    showCopyButton: boolean;
-    showLineNumbers: boolean;
-    showLineNumberLinks: boolean;
-    singleLine: boolean;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import type { CodeBlockProps, CodeBlockSlots, CodeBlockEventData } from '../../../types';
+type __VLS_Slots = CodeBlockSlots;
+declare const __VLS_component: import("vue").DefineComponent<CodeBlockProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    "code-block-render": (evt: CodeBlockEventData) => any;
+    "matching-lines-change": (evt: CodeBlockEventData) => any;
+    "query-change": (query: string) => any;
+    "filter-mode-change": (on: boolean) => any;
+    "reg-exp-mode-change": (on: boolean) => any;
+}, string, import("vue").PublicProps, Readonly<CodeBlockProps> & Readonly<{
+    "onCode-block-render"?: ((evt: CodeBlockEventData) => any) | undefined;
+    "onMatching-lines-change"?: ((evt: CodeBlockEventData) => any) | undefined;
+    "onQuery-change"?: ((query: string) => any) | undefined;
+    "onFilter-mode-change"?: ((on: boolean) => any) | undefined;
+    "onReg-exp-mode-change"?: ((on: boolean) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {

package/dist/types/components/KCodeBlock/KCodeBlockIconButton.vue.d.ts

@@ -1,44 +1,25 @@
-import { type PropType } from 'vue';
-import type { Theme } from '../../../types';
-declare const _default: __VLS_WithSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
-    theme: {
-        type: PropType<Theme>;
-        default: string;
-    };
-    active: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Only pass tooltip text if it's the copy button
-     */
-    copyTooltip: {
-        type: StringConstructor;
-        default: string;
-    };
-}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
-    theme: {
-        type: PropType<Theme>;
-        default: string;
-    };
-    active: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    /**
-     * Only pass tooltip text if it's the copy button
-     */
-    copyTooltip: {
-        type: StringConstructor;
-        default: string;
-    };
-}>> & Readonly<{}>, {
-    active: boolean;
-    theme: Theme;
-    copyTooltip: string;
-}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
-    default?: ((props: {}) => any) | undefined;
+import type { CodeBlockIconButtonProps } from '../../../types';
+import KButton from '../../components/KButton/KButton.vue';
+import KTooltip from '../../components/KTooltip/KTooltip.vue';
+declare const copyTooltipText: import("vue").Ref<string, string>;
+declare const attrs: {
+    [x: string]: unknown;
+};
+declare const onClick: () => void;
+declare const __VLS_ctx: InstanceType<__VLS_PickNotAny<typeof __VLS_self, new () => {}>>;
+declare var __VLS_12: {};
+type __VLS_Slots = __VLS_PrettifyGlobal<__VLS_OmitStringIndex<typeof __VLS_ctx.$slots> & {
+    default?: (props: typeof __VLS_12) => any;
 }>;
+declare const __VLS_self: import("vue").DefineComponent<CodeBlockIconButtonProps, {
+    KButton: typeof KButton;
+    KTooltip: typeof KTooltip;
+    copyTooltipText: typeof copyTooltipText;
+    attrs: typeof attrs;
+    onClick: typeof onClick;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<CodeBlockIconButtonProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_component: import("vue").DefineComponent<CodeBlockIconButtonProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<CodeBlockIconButtonProps> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
 export default _default;
 type __VLS_WithSlots<T, S> = T & {
     new (): {

package/dist/types/types/code-block.d.ts

@@ -8,3 +8,117 @@ export interface CodeBlockEventData {
 }
 export type Theme = 'light' | 'dark';
 export type CommandKeywords = 'toggleFilterMode' | 'toggleRegExpMode' | 'jumpToNextMatch' | 'jumpToPreviousMatch' | 'copyCode';
+/**
+ * @internal
+ */
+export interface CodeBlockIconButtonProps {
+    theme?: Theme;
+    active?: boolean;
+    /**
+     * Only pass tooltip text if it's the copy button
+     */
+    copyTooltip?: string;
+}
+export interface CodeBlockProps {
+    /**
+     * ID value used for form elements like the search input and its label.
+     */
+    id: string;
+    /**
+     * The code that will be rendered as a text node inside of a `<pre><code></code></pre>` fragment.
+     */
+    code: string;
+    /**
+     * The syntax language of `props.code` (e.g. `'json'`).
+     */
+    language: string;
+    /**
+     * Whether filter mode is initially active.
+     * @default false
+     */
+    initialFilterMode?: boolean;
+    /**
+     * Whether regular expression mode is initially active.
+     * @default false
+     */
+    initialRegExpMode?: boolean;
+    /**
+     * Shows an actions bar with a search input and related action buttons.
+     * @default false
+     */
+    searchable?: boolean;
+    /**
+     * The line numbers for the lines to highlight by default.
+     * @default []
+     */
+    highlightedLineNumbers?: string | (number | [number, number])[];
+    /**
+     * Allows controlling the processing state from outside the component. This allows a parent component to show the processing icon when it’s, for example, currently syntax highlighting the code.
+     * @default false
+     */
+    processing?: boolean;
+    /**
+     * Used as the initial value of the search input. Can be used to initialize a code block with a query which was read from client storage.
+     * @default ''
+     */
+    query?: string;
+    /**
+     * Controls whether to show a copy button. It copies the original code (i.e. the value of `props.code`) to the clipboard.
+     * @default true
+     */
+    showCopyButton?: boolean;
+    /**
+     * Controls whether to show line numbers.
+     * @default true
+     */
+    showLineNumbers?: boolean;
+    /**
+     * Controls whether to add links to the current line number.
+     * @default false
+     */
+    showLineNumberLinks?: boolean;
+    /**
+     * Controls the color scheme of the component.
+     * @default light
+     */
+    theme?: Theme;
+    /**
+     * Displays the code on a single line.
+     * @default false
+     */
+    singleLine?: boolean;
+    /**
+     * The max-height of the code block.
+     * @default none
+     */
+    maxHeight?: string;
+}
+export interface CodeBlockEmits {
+    /**
+     * Fired when the code block is rendered or re-rendered.
+     * This happens initially when mounting the component. It also happens when turning *off* filter mode (this renders a line-filtered sub set of the code and can’t be syntax highlighted after the fact). It also happens when the code changes (i.e. `props.code` is updated).
+     */
+    'code-block-render': [evt: CodeBlockEventData];
+    /**
+     * Fired when the matching line numbers are updated in response to a search.
+     */
+    'matching-lines-change': [evt: CodeBlockEventData];
+    /**
+     * Fired when the search query is updated.
+     */
+    'query-change': [query: string];
+    /**
+     * Fired when the filter mode is toggled.
+     */
+    'filter-mode-change': [on: boolean];
+    /**
+     * Fired when the regular expression mode is toggled.
+     */
+    'reg-exp-mode-change': [on: boolean];
+}
+export interface CodeBlockSlots {
+    /**
+     * Additional actions to be displayed in the code block.
+     */
+    'secondary-actions'?(): any;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kong/kongponents",
-  "version": "9.28.1",
+  "version": "9.28.2-pr.2684.3fe2fcabf.0",
   "description": "Kong Component library",
   "type": "module",
   "repository": {
@@ -26,33 +26,6 @@
     "./package.json": "./package.json",
     "./dist/*": "./dist/*"
   },
-  "scripts": {
-    "build:cli": "rimraf ./bin && tsc --project ./cli/tsconfig.json && chmod u+x ./bin/index.js",
-    "build:docs": "vitepress build docs",
-    "build:kongponents": "pnpm typecheck && vite build && vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly && tsc-alias -p './tsconfig.build.json'",
-    "build:visualize": "cross-env-shell BUILD_VISUALIZER=true vite build -m production",
-    "build": "pnpm build:cli && pnpm stylelint && pnpm lint && pnpm build:kongponents && pnpm build:docs",
-    "build:ci": "pnpm build:kongponents && pnpm build:docs",
-    "commit": "cz",
-    "create-kongponent": "node ./bin/index.js",
-    "sandbox:dev": "cross-env USE_SANDBOX=true vite",
-    "sandbox:build": "cross-env USE_SANDBOX=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
-    "sandbox:build:netlify": "cross-env USE_SANDBOX=true USE_NETLIFY=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
-    "sandbox:preview": "cross-env USE_SANDBOX=true vite preview",
-    "docs:build": "vitepress build docs",
-    "docs:dev": "vitepress dev docs",
-    "docs:serve": "vitepress serve docs",
-    "docs:preview": "vitepress preview docs --port 8080",
-    "typecheck": "vue-tsc -p './tsconfig.build.json' --noEmit",
-    "lint": "eslint",
-    "lint:fix": "eslint --fix",
-    "stylelint": "stylelint './src/**/*.{css,scss,sass,vue}'",
-    "stylelint:fix": "stylelint './src/**/*.{css,scss,sass,vue}' --fix",
-    "test": "cypress run --component -b chrome",
-    "test:open": "cypress open --component -b chrome",
-    "test:spec": "cypress run --component -b chrome --spec",
-    "semantic-release": "semantic-release"
-  },
   "dependencies": {
     "@floating-ui/vue": "^1.1.6",
     "@kong/icons": "^1.22.1",
@@ -183,7 +156,6 @@
   "engines": {
     "node": ">=v16.20.2 || >=18.12.1 || >=20.14.0"
   },
-  "packageManager": "pnpm@9.11.0",
   "volta": {
     "node": "20.17.0",
     "pnpm": "9.11.0"
@@ -197,5 +169,32 @@
       "jiraPrepend": "[",
       "jiraAppend": "]"
     }
+  },
+  "scripts": {
+    "build:cli": "rimraf ./bin && tsc --project ./cli/tsconfig.json && chmod u+x ./bin/index.js",
+    "build:docs": "vitepress build docs",
+    "build:kongponents": "pnpm typecheck && vite build && vue-tsc -p './tsconfig.build.json' --emitDeclarationOnly && tsc-alias -p './tsconfig.build.json'",
+    "build:visualize": "cross-env-shell BUILD_VISUALIZER=true vite build -m production",
+    "build": "pnpm build:cli && pnpm stylelint && pnpm lint && pnpm build:kongponents && pnpm build:docs",
+    "build:ci": "pnpm build:kongponents && pnpm build:docs",
+    "commit": "cz",
+    "create-kongponent": "node ./bin/index.js",
+    "sandbox:dev": "cross-env USE_SANDBOX=true vite",
+    "sandbox:build": "cross-env USE_SANDBOX=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
+    "sandbox:build:netlify": "cross-env USE_SANDBOX=true USE_NETLIFY=true vite build && shx cp sandbox/dist/index.html sandbox/dist/404.html",
+    "sandbox:preview": "cross-env USE_SANDBOX=true vite preview",
+    "docs:build": "vitepress build docs",
+    "docs:dev": "vitepress dev docs",
+    "docs:serve": "vitepress serve docs",
+    "docs:preview": "vitepress preview docs --port 8080",
+    "typecheck": "vue-tsc -p './tsconfig.build.json' --noEmit",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "stylelint": "stylelint './src/**/*.{css,scss,sass,vue}'",
+    "stylelint:fix": "stylelint './src/**/*.{css,scss,sass,vue}' --fix",
+    "test": "cypress run --component -b chrome",
+    "test:open": "cypress open --component -b chrome",
+    "test:spec": "cypress run --component -b chrome --spec",
+    "semantic-release": "semantic-release"
   }
-}
+}