@nextcloud/vue 8.5.0 → 9.0.0-alpha.0

package/dist/src/components/NcTextArea/NcTextArea.vue.d.ts

@@ -0,0 +1,205 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The value of the input field
+     */
+    modelValue: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The input label, always provide one for accessibility purposes.
+     * This will also be used as a placeholder unless the placeholder
+     * prop is populated with a different string.
+     */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Pass in true if you want to use an external label. This is useful
+     * if you need a label that looks different from the one provided by
+     * this component
+     */
+    labelOutside: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The placeholder of the input. This defaults as the string that's
+     * passed into the label prop. In order to remove the placeholder,
+     * pass in an empty string.
+     */
+    placeholder: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Toggles the success state of the component. Adds a checkmark icon.
+     * this cannot be used together with canClear.
+     */
+    success: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Toggles the error state of the component. Adds an error icon.
+     * this cannot be used together with canClear.
+     */
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Additional helper text message
+     *
+     * This will be displayed beneath the input field. In case the field is
+     * also marked as having an error, the text will be displayed in red.
+     */
+    helperText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Disable the input field
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Class to add to the input field.
+     * Necessary to use NcInputField in the NcActionInput component.
+     */
+    inputClass: {
+        type: (StringConstructor | ObjectConstructor)[];
+        default: string;
+    };
+    /**
+     * The resize CSS property sets whether an element is resizable, and if
+     * so, in which directions.
+     */
+    resize: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => boolean;
+    };
+}, any, any, {
+    computedId(): any;
+    inputName(): string;
+    hasPlaceholder(): boolean;
+    computedPlaceholder(): any;
+    isValidLabel(): any;
+    ariaDescribedby(): string | null;
+}, {
+    /**
+     * Focus the input element
+     *
+     * @public
+     */
+    focus(): void;
+    /**
+     * Select all the text in the input
+     *
+     * @public
+     */
+    select(): void;
+    handleInput(event: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The value of the input field
+     */
+    modelValue: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * The input label, always provide one for accessibility purposes.
+     * This will also be used as a placeholder unless the placeholder
+     * prop is populated with a different string.
+     */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Pass in true if you want to use an external label. This is useful
+     * if you need a label that looks different from the one provided by
+     * this component
+     */
+    labelOutside: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The placeholder of the input. This defaults as the string that's
+     * passed into the label prop. In order to remove the placeholder,
+     * pass in an empty string.
+     */
+    placeholder: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Toggles the success state of the component. Adds a checkmark icon.
+     * this cannot be used together with canClear.
+     */
+    success: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Toggles the error state of the component. Adds an error icon.
+     * this cannot be used together with canClear.
+     */
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Additional helper text message
+     *
+     * This will be displayed beneath the input field. In case the field is
+     * also marked as having an error, the text will be displayed in red.
+     */
+    helperText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Disable the input field
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Class to add to the input field.
+     * Necessary to use NcInputField in the NcActionInput component.
+     */
+    inputClass: {
+        type: (StringConstructor | ObjectConstructor)[];
+        default: string;
+    };
+    /**
+     * The resize CSS property sets whether an element is resizable, and if
+     * so, in which directions.
+     */
+    resize: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: unknown) => boolean;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    disabled: boolean;
+    label: string;
+    error: boolean;
+    resize: string;
+    success: boolean;
+    inputClass: string | Record<string, any>;
+    labelOutside: boolean;
+    placeholder: string;
+    helperText: string;
+}, {}>;
+export default _default;

package/dist/src/components/NcTextField/NcTextField.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {
+    propsToForward(): any;
+}, {
+    /**
+     * Focus the input element
+     *
+     * @public
+     */
+    focus(): void;
+    /**
+     * Select all the text in the input
+     *
+     * @public
+     */
+    select(): void;
+    handleInput(event: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {}, {}>;
+export default _default;

package/dist/src/components/NcTimezonePicker/NcTimezonePicker.vue.d.ts

@@ -0,0 +1,78 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * An array of additional timezones to include with the standard database. Useful if there is a custom timezone, e.g. read from user data
+     */
+    additionalTimezones: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * The selected timezone. Use v-model for two-way binding. The default timezone is floating, which means a time independent of timezone. See https://icalendar.org/CalDAV-Access-RFC-4791/7-3-date-and-floating-time.html for details.
+     */
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * ID of the inner vue-select element, can be used for labels like: `vs-${uid}__combobox`
+     */
+    uid: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: () => string;
+    };
+}, any, any, {
+    placeholder(): string;
+    selectedTimezone(): any;
+    options(): any[];
+}, {
+    t: (original: string, placeholders?: Record<string, string | number> | undefined) => string;
+    change(newValue: any): void;
+    /**
+     * Returns whether this is a continent label,
+     * or an actual timezone. Continent labels are not selectable.
+     *
+     * @param {string} option The option
+     * @return {boolean}
+     */
+    isSelectable(option: string): boolean;
+    /**
+     * Function to filter the timezone list.
+     * We search in the timezoneId, so both continent and region names can be matched.
+     *
+     * @param {object} option The timezone option
+     * @param {string} label The label of the timezone
+     * @param {string} search The search string
+     * @return {boolean}
+     */
+    filterBy(option: object, label: string, search: string): boolean;
+    matchTimezoneId(timezoneId: any, terms: any): any;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * An array of additional timezones to include with the standard database. Useful if there is a custom timezone, e.g. read from user data
+     */
+    additionalTimezones: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * The selected timezone. Use v-model for two-way binding. The default timezone is floating, which means a time independent of timezone. See https://icalendar.org/CalDAV-Access-RFC-4791/7-3-date-and-floating-time.html for details.
+     */
+    modelValue: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * ID of the inner vue-select element, can be used for labels like: `vs-${uid}__combobox`
+     */
+    uid: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: () => string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}, {
+    modelValue: string;
+    uid: string | number;
+    additionalTimezones: unknown[];
+}, {}>;
+export default _default;

package/dist/src/components/NcUserBubble/NcUserBubble.vue.d.ts

@@ -0,0 +1,180 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Override generated avatar, can be an url or an icon class
+     */
+    avatarImage: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Provide the user id if this is a user
+     */
+    user: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Displayed label
+     */
+    displayName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Whether or not to display the user-status
+     */
+    showUserStatus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Define the whole bubble as a link
+     */
+    url: {
+        type: StringConstructor;
+        default: undefined;
+        validator: (url: unknown) => boolean;
+    };
+    /**
+     * Default popover state. Requires the UserBubble
+     * to have some content to render inside the popover
+     */
+    open: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Use the primary colour
+     */
+    primary: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * This is the height of the component
+     */
+    size: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * This is the margin of the avatar (size - margin = avatar size)
+     */
+    margin: {
+        type: NumberConstructor;
+        default: number;
+    };
+}, any, any, {
+    /**
+     * Is the provided avatar url valid or not
+     *
+     * @return {boolean}
+     */
+    isAvatarUrl(): boolean;
+    /**
+     * Do we have a custom avatar or not
+     *
+     * @return {boolean}
+     */
+    isCustomAvatar(): boolean;
+    hasUrl(): any;
+    isLinkComponent(): "div" | "a";
+    styles(): {
+        content: {
+            height: string;
+            lineHeight: string;
+            borderRadius: string;
+        };
+        avatar: {
+            marginLeft: string;
+        };
+    };
+}, {
+    onOpenChange(state: any): void;
+    /**
+     * Catch and forward click event to parent
+     *
+     * @param {Event} event the click event
+     */
+    onClick(event: Event): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "update:open")[], "click" | "update:open", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Override generated avatar, can be an url or an icon class
+     */
+    avatarImage: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Provide the user id if this is a user
+     */
+    user: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Displayed label
+     */
+    displayName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Whether or not to display the user-status
+     */
+    showUserStatus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Define the whole bubble as a link
+     */
+    url: {
+        type: StringConstructor;
+        default: undefined;
+        validator: (url: unknown) => boolean;
+    };
+    /**
+     * Default popover state. Requires the UserBubble
+     * to have some content to render inside the popover
+     */
+    open: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Use the primary colour
+     */
+    primary: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * This is the height of the component
+     */
+    size: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * This is the margin of the avatar (size - margin = avatar size)
+     */
+    margin: {
+        type: NumberConstructor;
+        default: number;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+    "onUpdate:open"?: ((...args: any[]) => any) | undefined;
+}, {
+    size: number;
+    url: string;
+    primary: boolean;
+    open: boolean;
+    user: string;
+    showUserStatus: boolean;
+    displayName: string;
+    margin: number;
+    avatarImage: string;
+}, {}>;
+export default _default;

package/dist/src/components/NcUserBubble/NcUserBubbleDiv.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
+export default _default;

package/dist/src/components/NcUserStatusIcon/NcUserStatusIcon.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (props: Record<string, any> & {}) => any;
+export default _default;

package/dist/src/components/NcVNodes/NcVNodes.vue.d.ts

@@ -0,0 +1,20 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The vnodes to render
+     */
+    vnodes: {
+        type: (ObjectConstructor | ArrayConstructor)[];
+        default: null;
+    };
+}, any, any, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The vnodes to render
+     */
+    vnodes: {
+        type: (ObjectConstructor | ArrayConstructor)[];
+        default: null;
+    };
+}>>, {
+    vnodes: Record<string, any> | unknown[];
+}, {}>;
+export default _default;

package/dist/src/components/index.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+export { default as NcActionButton } from './NcActionButton/index.js';
+export { default as NcActionButtonGroup } from './NcActionButtonGroup/index.js';
+export { default as NcActionCaption } from './NcActionCaption/index.js';
+export { default as NcActionCheckbox } from './NcActionCheckbox/index.js';
+export { default as NcActionInput } from './NcActionInput/index.js';
+export { default as NcActionLink } from './NcActionLink/index.js';
+export { default as NcActionRadio } from './NcActionRadio/index.js';
+export { default as NcActionRouter } from './NcActionRouter/index.js';
+export { default as NcActions } from './NcActions/index.js';
+export { default as NcActionSeparator } from './NcActionSeparator/index.js';
+export { default as NcActionText } from './NcActionText/index.js';
+export { default as NcActionTextEditable } from './NcActionTextEditable/index.js';
+export { default as NcAppContent } from './NcAppContent/index.js';
+export { default as NcAppContentDetails } from './NcAppContentDetails/index.js';
+export { default as NcAppContentList } from './NcAppContentList/index.js';
+export { default as NcAppNavigation } from './NcAppNavigation/index.js';
+export { default as NcAppNavigationCaption } from './NcAppNavigationCaption/index.js';
+export { default as NcAppNavigationIconBullet } from './NcAppNavigationIconBullet/index.js';
+export { default as NcAppNavigationItem } from './NcAppNavigationItem/index.js';
+export { default as NcAppNavigationNew } from './NcAppNavigationNew/index.js';
+export { default as NcAppNavigationNewItem } from './NcAppNavigationNewItem/index.js';
+export { default as NcAppNavigationSettings } from './NcAppNavigationSettings/index.js';
+export { default as NcAppNavigationSpacer } from './NcAppNavigationSpacer/index.js';
+export { default as NcAppSettingsDialog } from './NcAppSettingsDialog/index.js';
+export { default as NcAppSettingsSection } from './NcAppSettingsSection/index.js';
+export { default as NcAppSidebar } from './NcAppSidebar/index.js';
+export { default as NcAppSidebarTab } from './NcAppSidebarTab/index.js';
+export { default as NcAvatar } from './NcAvatar/index.js';
+export { default as NcBreadcrumb } from './NcBreadcrumb/index.js';
+export { default as NcBreadcrumbs } from './NcBreadcrumbs/index.js';
+export { default as NcButton } from './NcButton/index';
+export { default as NcCheckboxRadioSwitch } from './NcCheckboxRadioSwitch/index.js';
+export { default as NcColorPicker } from './NcColorPicker/index.js';
+export { default as NcContent } from './NcContent/index.js';
+export { default as NcCounterBubble } from './NcCounterBubble/index.js';
+export { default as NcDashboardWidget } from './NcDashboardWidget/index.js';
+export { default as NcDashboardWidgetItem } from './NcDashboardWidgetItem/index.js';
+export { default as NcDateTime } from './NcDateTime/index.js';
+export { default as NcDateTimePicker } from './NcDateTimePicker/index.js';
+export { default as NcDateTimePickerNative } from './NcDateTimePickerNative/index.js';
+export { default as NcDialog } from './NcDialog/index.js';
+export { default as NcDialogButton } from './NcDialogButton/index.js';
+export { default as NcEmojiPicker } from './NcEmojiPicker/index.js';
+export { default as NcEmptyContent } from './NcEmptyContent/index.js';
+export { default as NcGuestContent } from './NcGuestContent/index.js';
+export { default as NcHeaderMenu } from './NcHeaderMenu/index.js';
+export { default as NcHighlight } from './NcHighlight/index.js';
+export { default as NcIconSvgWrapper } from './NcIconSvgWrapper/index.js';
+export { default as NcListItem } from './NcListItem/index.js';
+export { default as NcListItemIcon } from './NcListItemIcon/index.js';
+export { default as NcLoadingIcon } from './NcLoadingIcon/index.js';
+export { default as NcModal } from './NcModal/index.js';
+export { default as NcNoteCard } from './NcNoteCard/index.js';
+export { default as NcPasswordField } from './NcPasswordField/index.js';
+export { default as NcPopover } from './NcPopover/index.js';
+export { default as NcProgressBar } from './NcProgressBar/index.js';
+export { default as NcRelatedResourcesPanel } from './NcRelatedResourcesPanel/index.js';
+export { default as NcRichContenteditable, NcAutoCompleteResult, NcMentionBubble } from './NcRichContenteditable/index.js';
+export { default as NcRichText } from './NcRichText/index.js';
+export { default as NcSavingIndicatorIcon } from './NcSavingIndicatorIcon/index.js';
+export { default as NcSelect } from './NcSelect/index.js';
+export { default as NcSelectTags } from './NcSelectTags/index.js';
+export { default as NcSettingsInputText } from './NcSettingsInputText/index.js';
+export { default as NcSettingsSection } from './NcSettingsSection/index.js';
+export { default as NcSettingsSelectGroup } from './NcSettingsSelectGroup/index.js';
+export { default as NcTextArea } from './NcTextArea/index.js';
+export { default as NcTextField } from './NcTextField/index.js';
+export { default as NcTimezonePicker } from './NcTimezonePicker/index.js';
+export { default as NcUserBubble } from './NcUserBubble/index.js';
+export { default as NcUserStatusIcon } from './NcUserStatusIcon/index.js';

package/dist/src/directives/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+export { default as Focus } from './Focus/index.js';
+export { default as Linkify } from './Linkify/index.js';
+export { default as Tooltip } from './Tooltip/index.js';

package/dist/src/index.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+export * from './components/index';
+export * from './composables/index.js';
+export * from './functions/index.js';
+export * from './directives/index.js';
+export * from './mixins/index.js';
+export { NextcloudVuePlugin } from './plugin';

package/dist/src/plugin.d.ts

@@ -0,0 +1,16 @@
+import type { Plugin } from 'vue';
+/**
+ * Install all Nextcloud Vue components and directives globally
+ * @example
+ * ```js
+ * import { NextcloudVuePlugin } from '@nextcloud/vue'
+ * import { createApp } from 'vue'
+ *
+ * const app = createApp({})
+ *
+ * app.use(NextcloudVuePlugin, {
+ *   // optional options
+ * })
+ * ```
+ */
+export declare const NextcloudVuePlugin: Plugin;