@nextcloud/vue 8.6.0 → 9.0.0-alpha.1

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

@@ -0,0 +1,237 @@
+import type { PropType } from 'vue';
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * Set the text and icon alignment
+     *
+     * @default 'center'
+     * @type {'start' | 'start-reverse' | 'center' | 'center-reverse' | 'end' | 'end-reverse'}
+     */
+    alignment: {
+        type: PropType<"start" | "start-reverse" | "center" | "center-reverse" | "end" | "end-reverse">;
+        default: string;
+        validator(alignment: unknown): boolean;
+    };
+    /**
+     * Toggles the disabled state of the button on and off.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specifies the button type
+     * If left empty, the default button style will be applied.
+     *
+     * @default 'secondary'
+     * @type {'primary' | 'secondary' | 'tertiary' | 'tertiary-no-background' | 'tertiary-on-primary' | 'error' | 'warning' | 'success'}
+     */
+    type: {
+        type: PropType<"error" | "primary" | "secondary" | "tertiary" | "tertiary-no-background" | "tertiary-on-primary" | "warning" | "success">;
+        validator(value: unknown): boolean;
+        default: string;
+    };
+    /**
+     * Specifies the button native type
+     * If left empty, the default "button" type will be used.
+     *
+     * @type {'submit' | 'reset' | 'button'}
+     */
+    nativeType: {
+        type: PropType<"button" | "reset" | "submit">;
+        validator(value: unknown): boolean;
+        default: string;
+    };
+    /**
+     * Specifies whether the button should span all the available width.
+     * By default, buttons span the whole width of the container.
+     */
+    wide: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Always try to provide an aria-label to your button. Make it more
+     * specific than the button's name by provide some more context. E.g. if
+     * the name of the button is "send" in the Mail app, the aria label could
+     * be "Send email".
+     */
+    ariaLabel: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Providing the href attribute turns the button component into an `a`
+     * element.
+     */
+    href: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Providing the download attribute with href downloads file when clicking.
+     */
+    download: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Providing the to attribute turns the button component into a `router-link`
+     * element. Takes precedence over the href attribute.
+     */
+    to: {
+        type: (StringConstructor | ObjectConstructor)[];
+        default: null;
+    };
+    /**
+     * @deprecated To be removed in @nextcloud/vue 9. Migration guide: remove ariaHidden prop from NcAction* components.
+     * @todo Add a check in @nextcloud/vue 9 that this prop is not provided,
+     * otherwise root element will inherit incorrect aria-hidden.
+     */
+    ariaHidden: {
+        type: BooleanConstructor;
+        default: null;
+    };
+    /**
+     * The pressed state of the button if it has a checked state
+     * This will add the `aria-pressed` attribute and for the button to have the primary style in checked state.
+     *
+     * Pressed state is not supported for links
+     */
+    pressed: {
+        type: BooleanConstructor;
+        default: null;
+    };
+}, unknown, unknown, {
+    /**
+     * The real type to be used for the button, enforces `primary` for pressed state and, if stateful button, any other type for not pressed state
+     * Otherwise the type property is used.
+     */
+    realType(): "error" | "primary" | "secondary" | "tertiary" | "tertiary-no-background" | "tertiary-on-primary" | "warning" | "success";
+    /**
+     * The flexbox alignment of the button content
+     */
+    flexAlignment(): string;
+    /**
+     * If the button content should be reversed (icon on the end)
+     */
+    isReverseAligned(): boolean;
+    ncPopoverTriggerAttrs(): any;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "update:pressed")[], "click" | "update:pressed", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Set the text and icon alignment
+     *
+     * @default 'center'
+     * @type {'start' | 'start-reverse' | 'center' | 'center-reverse' | 'end' | 'end-reverse'}
+     */
+    alignment: {
+        type: PropType<"start" | "start-reverse" | "center" | "center-reverse" | "end" | "end-reverse">;
+        default: string;
+        validator(alignment: unknown): boolean;
+    };
+    /**
+     * Toggles the disabled state of the button on and off.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Specifies the button type
+     * If left empty, the default button style will be applied.
+     *
+     * @default 'secondary'
+     * @type {'primary' | 'secondary' | 'tertiary' | 'tertiary-no-background' | 'tertiary-on-primary' | 'error' | 'warning' | 'success'}
+     */
+    type: {
+        type: PropType<"error" | "primary" | "secondary" | "tertiary" | "tertiary-no-background" | "tertiary-on-primary" | "warning" | "success">;
+        validator(value: unknown): boolean;
+        default: string;
+    };
+    /**
+     * Specifies the button native type
+     * If left empty, the default "button" type will be used.
+     *
+     * @type {'submit' | 'reset' | 'button'}
+     */
+    nativeType: {
+        type: PropType<"button" | "reset" | "submit">;
+        validator(value: unknown): boolean;
+        default: string;
+    };
+    /**
+     * Specifies whether the button should span all the available width.
+     * By default, buttons span the whole width of the container.
+     */
+    wide: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Always try to provide an aria-label to your button. Make it more
+     * specific than the button's name by provide some more context. E.g. if
+     * the name of the button is "send" in the Mail app, the aria label could
+     * be "Send email".
+     */
+    ariaLabel: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Providing the href attribute turns the button component into an `a`
+     * element.
+     */
+    href: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Providing the download attribute with href downloads file when clicking.
+     */
+    download: {
+        type: StringConstructor;
+        default: null;
+    };
+    /**
+     * Providing the to attribute turns the button component into a `router-link`
+     * element. Takes precedence over the href attribute.
+     */
+    to: {
+        type: (StringConstructor | ObjectConstructor)[];
+        default: null;
+    };
+    /**
+     * @deprecated To be removed in @nextcloud/vue 9. Migration guide: remove ariaHidden prop from NcAction* components.
+     * @todo Add a check in @nextcloud/vue 9 that this prop is not provided,
+     * otherwise root element will inherit incorrect aria-hidden.
+     */
+    ariaHidden: {
+        type: BooleanConstructor;
+        default: null;
+    };
+    /**
+     * The pressed state of the button if it has a checked state
+     * This will add the `aria-pressed` attribute and for the button to have the primary style in checked state.
+     *
+     * Pressed state is not supported for links
+     */
+    pressed: {
+        type: BooleanConstructor;
+        default: null;
+    };
+}>> & {
+    onClick?: ((...args: any[]) => any) | undefined;
+    "onUpdate:pressed"?: ((...args: any[]) => any) | undefined;
+}, {
+    ariaHidden: boolean;
+    disabled: boolean;
+    type: "error" | "primary" | "secondary" | "tertiary" | "tertiary-no-background" | "tertiary-on-primary" | "warning" | "success";
+    nativeType: "button" | "reset" | "submit";
+    alignment: "start" | "start-reverse" | "center" | "center-reverse" | "end" | "end-reverse";
+    wide: boolean;
+    ariaLabel: string;
+    href: string;
+    download: string;
+    to: string | Record<string, any>;
+    pressed: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,22 @@
+/**
+ * @copyright Copyright (c) 2020 Marco Ambrosini <marcoambrosini@icloud.com>
+ *
+ * @author Marco Ambrosini <marcoambrosini@icloud.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 } from './NcButton.vue';

package/dist/src/components/NcCheckboxRadioSwitch/NcCheckboxContent.vue.d.ts

@@ -0,0 +1,6 @@
+export const TYPE_CHECKBOX: "checkbox";
+export const TYPE_RADIO: "radio";
+export const TYPE_SWITCH: "switch";
+export const TYPE_BUTTON: "button";
+declare const _default: (props: Record<string, any> & {}) => any;
+export default _default;

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

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

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

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

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

@@ -0,0 +1,23 @@
+declare const _default: import("vue").DefineComponent<{
+    appName: {
+        type: StringConstructor;
+        required: true;
+    };
+}, {
+    isMobile: Readonly<import("vue").Ref<boolean>>;
+}, {
+    hasAppNavigation: boolean;
+    currentFocus: string;
+}, {
+    currentImage(): string;
+}, {
+    t: (original: string, placeholders?: Record<string, string | number> | undefined) => string;
+    openAppNavigation(): void;
+    setAppNavigation(value: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    appName: {
+        type: StringConstructor;
+        required: true;
+    };
+}>>, {}, {}>;
+export default _default;

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

@@ -0,0 +1,41 @@
+declare const _default: import("vue").DefineComponent<{
+    type: {
+        type: StringConstructor;
+        default: string;
+        validator(value: unknown): boolean;
+    };
+    /**
+     * Specifies whether the component is used within a component that is
+     * active and therefore has a primary background. Inverts the color of
+     * this component when that is the case.
+     */
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, any, {
+    counterClassObject(): {
+        'counter-bubble__counter--highlighted': boolean;
+        'counter-bubble__counter--outlined': boolean;
+        active: any;
+    };
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    type: {
+        type: StringConstructor;
+        default: string;
+        validator(value: unknown): boolean;
+    };
+    /**
+     * Specifies whether the component is used within a component that is
+     * active and therefore has a primary background. Inverts the color of
+     * this component when that is the case.
+     */
+    active: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    type: string;
+    active: boolean;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,142 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * An array containing the items to show (specific structure must be respected,
+     * except if you override item rendering in the default slot).
+     */
+    items: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * If this is set, a "show more" text is displayed on the widget's bottom.
+     * It's a link pointing to this URL.
+     */
+    showMoreUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text of show more button.
+     *
+     * Expected to be in the form "More {itemName} …"
+     */
+    showMoreLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A boolean to put the widget in a loading state.
+     */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * An object containing context menu entries that will be displayed for each item.
+     */
+    itemMenu: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /**
+     * Whether both the items and the empty content message are shown.
+     * Usefull for e.g. showing "No mentions" and a list of elements.
+     */
+    showItemsAndEmptyContent: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The text to show in the empty content area.
+     */
+    emptyContentMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text to show in the half empty content area.
+     */
+    halfEmptyContentMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+}, any, any, {
+    handlers(): {};
+    displayedItems(): any;
+    showHalfEmptyContentArea(): any;
+    halfEmptyContentString(): any;
+    maxItemNumber(): 5 | 7;
+    showMore(): any;
+}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * An array containing the items to show (specific structure must be respected,
+     * except if you override item rendering in the default slot).
+     */
+    items: {
+        type: ArrayConstructor;
+        default: () => never[];
+    };
+    /**
+     * If this is set, a "show more" text is displayed on the widget's bottom.
+     * It's a link pointing to this URL.
+     */
+    showMoreUrl: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text of show more button.
+     *
+     * Expected to be in the form "More {itemName} …"
+     */
+    showMoreLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * A boolean to put the widget in a loading state.
+     */
+    loading: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * An object containing context menu entries that will be displayed for each item.
+     */
+    itemMenu: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /**
+     * Whether both the items and the empty content message are shown.
+     * Usefull for e.g. showing "No mentions" and a list of elements.
+     */
+    showItemsAndEmptyContent: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The text to show in the empty content area.
+     */
+    emptyContentMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * The text to show in the half empty content area.
+     */
+    halfEmptyContentMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    loading: boolean;
+    itemMenu: Record<string, any>;
+    items: unknown[];
+    showMoreUrl: string;
+    showMoreLabel: string;
+    showItemsAndEmptyContent: boolean;
+    emptyContentMessage: string;
+    halfEmptyContentMessage: string;
+}, {}>;
+export default _default;

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

@@ -0,0 +1,170 @@
+declare const _default: import("vue").DefineComponent<{
+    /**
+     * The item id (optional)
+     */
+    id: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+    /**
+     * The item element is a link to this URL (optional)
+     */
+    targetUrl: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Where to get the avatar image. (optional) Used if avatarUsername is not defined.
+     */
+    avatarUrl: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Name to provide to the Avatar. (optional) Used if avatarUrl is not defined.
+     */
+    avatarUsername: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Is the avatarUsername not a user's name? (optional, false by default)
+     */
+    avatarIsNoUser: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Small icon to display on the bottom-right corner of the avatar (optional)
+     */
+    overlayIconUrl: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Item main text (mandatory)
+     */
+    mainText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Item subline text (optional)
+     */
+    subText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An object containing context menu entries that will be displayed for each items (optional)
+     */
+    itemMenu: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /**
+     * Specify whether the 3 dot menu is forced when only one action is present
+     */
+    forceMenu: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, any, {
+    hovered: boolean;
+}, {
+    item(): {
+        id: any;
+        targetUrl: any;
+        avatarUrl: any;
+        avatarUsername: any;
+        overlayIconUrl: any;
+        mainText: any;
+        subText: any;
+    };
+    gotMenu(): boolean;
+    gotOverlayIcon(): any;
+}, {
+    onLinkClick(event: any): void;
+}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * The item id (optional)
+     */
+    id: {
+        type: (StringConstructor | NumberConstructor)[];
+        default: undefined;
+    };
+    /**
+     * The item element is a link to this URL (optional)
+     */
+    targetUrl: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Where to get the avatar image. (optional) Used if avatarUsername is not defined.
+     */
+    avatarUrl: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Name to provide to the Avatar. (optional) Used if avatarUrl is not defined.
+     */
+    avatarUsername: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Is the avatarUsername not a user's name? (optional, false by default)
+     */
+    avatarIsNoUser: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Small icon to display on the bottom-right corner of the avatar (optional)
+     */
+    overlayIconUrl: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /**
+     * Item main text (mandatory)
+     */
+    mainText: {
+        type: StringConstructor;
+        required: true;
+    };
+    /**
+     * Item subline text (optional)
+     */
+    subText: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * An object containing context menu entries that will be displayed for each items (optional)
+     */
+    itemMenu: {
+        type: ObjectConstructor;
+        default: () => {};
+    };
+    /**
+     * Specify whether the 3 dot menu is forced when only one action is present
+     */
+    forceMenu: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>>, {
+    id: string | number;
+    forceMenu: boolean;
+    avatarUrl: string;
+    targetUrl: string;
+    avatarUsername: string;
+    avatarIsNoUser: boolean;
+    overlayIconUrl: string;
+    subText: string;
+    itemMenu: Record<string, any>;
+}, {}>;
+export default _default;

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

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

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

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

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

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

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

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

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

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