pdap-design-system 3.1.0 → 3.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@ _A `Vue` component library, styling system, and image asset repository for PDAP-
6
6
 
7
7
  [![Discord](https://img.shields.io/discord/828274060034965575?logo=discord&style=for-the-badge&color=blue)](https://discord.gg/vKhDv7nC8B)
8
8
 
9
- ## Usage
9
+ ## Usage
10
10
 
11
11
  1. Install the package
12
12
 
@@ -0,0 +1,88 @@
1
+ declare const _default: <T>(__VLS_props: {
2
+ onOnInput?: ((...args: any[]) => any) | undefined;
3
+ onOnFocus?: ((...args: any[]) => any) | undefined;
4
+ onOnBlur?: ((...args: any[]) => any) | undefined;
5
+ onSelectItem?: ((...args: any[]) => any) | undefined;
6
+ id: string;
7
+ placeholder?: string | undefined;
8
+ items: T[] | undefined;
9
+ formatItemForDisplay?: ((item: T) => string) | undefined;
10
+ error?: string | undefined;
11
+ position?: "top" | "bottom" | undefined;
12
+ } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, __VLS_ctx?: {
13
+ attrs: any;
14
+ emit: (event: "onInput" | "onFocus" | "onBlur" | "selectItem", ...args: any[]) => void;
15
+ slots: {
16
+ label?(_: {}): any;
17
+ error?(_: {}): any;
18
+ item?(_: T): any;
19
+ "not-found"?(_: {}): any;
20
+ };
21
+ } | undefined, __VLS_expose?: ((exposed: import("vue").ShallowUnwrapRef<{
22
+ boldMatchText: (text: string) => string;
23
+ clearInput: () => void;
24
+ focusInput: () => void;
25
+ readonly value: string;
26
+ }>) => void) | undefined, __VLS_setup?: Promise<{
27
+ props: {
28
+ onOnInput?: ((...args: any[]) => any) | undefined;
29
+ onOnFocus?: ((...args: any[]) => any) | undefined;
30
+ onOnBlur?: ((...args: any[]) => any) | undefined;
31
+ onSelectItem?: ((...args: any[]) => any) | undefined;
32
+ id: string;
33
+ placeholder?: string | undefined;
34
+ items: T[] | undefined;
35
+ formatItemForDisplay?: ((item: T) => string) | undefined;
36
+ error?: string | undefined;
37
+ position?: "top" | "bottom" | undefined;
38
+ } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
39
+ expose(exposed: import("vue").ShallowUnwrapRef<{
40
+ boldMatchText: (text: string) => string;
41
+ clearInput: () => void;
42
+ focusInput: () => void;
43
+ readonly value: string;
44
+ }>): void;
45
+ attrs: any;
46
+ slots: {
47
+ label?(_: {}): any;
48
+ error?(_: {}): any;
49
+ item?(_: T): any;
50
+ "not-found"?(_: {}): any;
51
+ };
52
+ emit: (event: "onInput" | "onFocus" | "onBlur" | "selectItem", ...args: any[]) => void;
53
+ }>) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
54
+ [key: string]: any;
55
+ }> & {
56
+ __ctx?: {
57
+ props: {
58
+ onOnInput?: ((...args: any[]) => any) | undefined;
59
+ onOnFocus?: ((...args: any[]) => any) | undefined;
60
+ onOnBlur?: ((...args: any[]) => any) | undefined;
61
+ onSelectItem?: ((...args: any[]) => any) | undefined;
62
+ id: string;
63
+ placeholder?: string | undefined;
64
+ items: T[] | undefined;
65
+ formatItemForDisplay?: ((item: T) => string) | undefined;
66
+ error?: string | undefined;
67
+ position?: "top" | "bottom" | undefined;
68
+ } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps;
69
+ expose(exposed: import("vue").ShallowUnwrapRef<{
70
+ boldMatchText: (text: string) => string;
71
+ clearInput: () => void;
72
+ focusInput: () => void;
73
+ readonly value: string;
74
+ }>): void;
75
+ attrs: any;
76
+ slots: {
77
+ label?(_: {}): any;
78
+ error?(_: {}): any;
79
+ item?(_: T): any;
80
+ "not-found"?(_: {}): any;
81
+ };
82
+ emit: (event: "onInput" | "onFocus" | "onBlur" | "selectItem", ...args: any[]) => void;
83
+ } | undefined;
84
+ };
85
+ export default _default;
86
+ type __VLS_Prettify<T> = {
87
+ [K in keyof T]: T[K];
88
+ } & {};
@@ -0,0 +1 @@
1
+ export { default as AsyncTypeahead } from './AsyncTypeahead.vue';
@@ -0,0 +1,8 @@
1
+ export interface PdapAsyncTypeaheadProps<T> {
2
+ id: string;
3
+ placeholder?: string;
4
+ items: T[] | undefined;
5
+ formatItemForDisplay?: (item: T) => string;
6
+ error?: string;
7
+ position?: 'top' | 'bottom';
8
+ }
@@ -16,11 +16,11 @@ import { PdapErrorBoundaryProps, PdapErrorEmitted } from './types';
16
16
  *
17
17
  * <template>
18
18
  * <AuthWrapper>
19
- * <Header :logo-image-src="lockup" />
19
+ * <Header />
20
20
  * <ErrorBoundary component="main">
21
21
  * <router-view />
22
22
  * </ErrorBoundary>
23
- * <Footer :logo-image-src="acronym" />
23
+ * <Footer />
24
24
  * </AuthWrapper>
25
25
  * </template>
26
26
  *
@@ -53,8 +53,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
53
53
  }>>> & {
54
54
  onOnError?: ((args_0: PdapErrorEmitted) => any) | undefined;
55
55
  }, {
56
- params: Record<string, string>;
57
56
  onError: (error: Error, target?: ComponentPublicInstance | null | undefined, info?: string | undefined) => void;
57
+ params: Record<string, string>;
58
58
  component: string;
59
59
  }, {}>, {
60
60
  default?(_: {}): any;
@@ -1,17 +1,7 @@
1
- import { PdapFooterProps } from './types';
2
1
  /**
3
2
  * # `Footer`
4
3
  *
5
4
  *
6
5
  */
7
- declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<PdapFooterProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<PdapFooterProps>>>, {}, {}>;
6
+ declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
8
7
  export default _default;
9
- type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
10
- type __VLS_TypePropsToRuntimeProps<T> = {
11
- [K in keyof T]-?: {} extends Pick<T, K> ? {
12
- type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
13
- } : {
14
- type: import('vue').PropType<T[K]>;
15
- required: true;
16
- };
17
- };
@@ -3,9 +3,10 @@
3
3
  */
4
4
  export declare const FOOTER_LINK_ICONS: {
5
5
  readonly GITHUB: "github";
6
- readonly LINKEDIN: "linkedin";
7
6
  readonly DISCORD: "discord";
8
7
  readonly JOBS: "jobs";
9
8
  readonly NEWSLETTER: "newsletter";
10
9
  readonly DOCS: "docs";
10
+ readonly EMAIL: "email";
11
+ readonly PUBLISH: "publish";
11
12
  };
@@ -6,9 +6,3 @@ export interface PdapFooterSocialLinks {
6
6
  icon?: FooterIconName;
7
7
  }
8
8
  export type FooterIconName = (typeof FOOTER_LINK_ICONS)[keyof typeof FOOTER_LINK_ICONS];
9
- export interface PdapFooterProps {
10
- fundraisingData: {
11
- raised: number;
12
- goal: number;
13
- };
14
- }
@@ -113,8 +113,8 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
113
113
  }>, {
114
114
  setValues: <T extends Record<string, string>>(update: T) => void;
115
115
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
116
- change: (...args: any[]) => void;
117
116
  submit: (...args: any[]) => void;
117
+ change: (...args: any[]) => void;
118
118
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapFormProps>, {
119
119
  error: null;
120
120
  resetOn: string;
@@ -14,9 +14,9 @@ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__
14
14
  custom: ((value: unknown) => boolean) | ((value: unknown) => boolean);
15
15
  } | undefined>, Record<PropertyKey, unknown>>>;
16
16
  }, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
17
- change: (...args: any[]) => void;
18
17
  error: (...args: any[]) => void;
19
18
  submit: (...args: any[]) => void;
19
+ change: (...args: any[]) => void;
20
20
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<PdapFormPropsV2>>> & {
21
21
  onChange?: ((...args: any[]) => any) | undefined;
22
22
  onSubmit?: ((...args: any[]) => any) | undefined;
@@ -4,21 +4,18 @@ import { PdapHeaderProps } from './types';
4
4
  *
5
5
  * ## Props
6
6
  * @prop {string} logoImageSrc Src for the PDAP logo image to be displayed
7
- * @prop {string } logoImageAnchorPath Path for the link that wraps the PDAP logo image
7
+ * @prop {string } logoAnchorPath Path for the link that wraps the PDAP logo image
8
8
  *
9
9
  * ## Notes
10
10
  * The `Header` component does not require any props to be passed. But keep in mind that it is responsible for rendering the `Nav` component. Consuming applications will need to `provide` an array of nav links -- **there are no defaults for this**, you must `provide` these links either 1\. in a layout component (see example below), at the route level, or at the app level. This allows for flexibility in which links are rendered on which routes
11
11
  *
12
12
  */
13
13
  declare const _default: import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapHeaderProps>, {
14
- logoImageSrc: string;
15
- logoImageAnchorPath: string;
14
+ logoAnchorPath: string;
16
15
  }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapHeaderProps>, {
17
- logoImageSrc: string;
18
- logoImageAnchorPath: string;
16
+ logoAnchorPath: string;
19
17
  }>>>, {
20
- logoImageSrc: string;
21
- logoImageAnchorPath: string;
18
+ logoAnchorPath: string;
22
19
  }, {}>;
23
20
  export default _default;
24
21
  type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
@@ -1,4 +1,3 @@
1
1
  export interface PdapHeaderProps {
2
- logoImageSrc?: string;
3
- logoImageAnchorPath?: string;
2
+ logoAnchorPath?: string;
4
3
  }
@@ -2,18 +2,21 @@ import { PdapSelectOption as Option, PdapInputSelectProps } from './types';
2
2
  declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapInputSelectProps>, {
3
3
  combobox: boolean;
4
4
  placeholder: string;
5
+ position: string;
5
6
  filter: (searchText: any, options: any) => any;
6
7
  }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
7
8
  change: (...args: any[]) => void;
8
9
  }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapInputSelectProps>, {
9
10
  combobox: boolean;
10
11
  placeholder: string;
12
+ position: string;
11
13
  filter: (searchText: any, options: any) => any;
12
14
  }>>> & {
13
15
  onChange?: ((...args: any[]) => any) | undefined;
14
16
  }, {
15
17
  filter: (searchText: string, options: Option[]) => Option[];
16
18
  placeholder: string;
19
+ position: "top" | "bottom";
17
20
  combobox: boolean;
18
21
  }, {}>, {
19
22
  label?(_: {}): any;
@@ -7,6 +7,7 @@ export interface PdapInputSelectProps {
7
7
  label?: string;
8
8
  name: string;
9
9
  placeholder?: string;
10
+ position?: 'top' | 'bottom';
10
11
  options: PdapSelectOption[];
11
12
  combobox?: boolean;
12
13
  filter?: (searchText: string, options: PdapSelectOption[]) => PdapSelectOption[];
@@ -0,0 +1,41 @@
1
+ import { PdapInputSelectProps } from './types';
2
+ declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapInputSelectProps>, {
3
+ placeholder: string;
4
+ position: string;
5
+ }>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
6
+ change: (...args: any[]) => void;
7
+ }, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<PdapInputSelectProps>, {
8
+ placeholder: string;
9
+ position: string;
10
+ }>>> & {
11
+ onChange?: ((...args: any[]) => any) | undefined;
12
+ }, {
13
+ placeholder: string;
14
+ position: "top" | "bottom";
15
+ }, {}>, {
16
+ label?(_: {}): any;
17
+ error?(_: {}): any;
18
+ }>;
19
+ export default _default;
20
+ type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
21
+ type __VLS_TypePropsToRuntimeProps<T> = {
22
+ [K in keyof T]-?: {} extends Pick<T, K> ? {
23
+ type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
24
+ } : {
25
+ type: import('vue').PropType<T[K]>;
26
+ required: true;
27
+ };
28
+ };
29
+ type __VLS_WithDefaults<P, D> = {
30
+ [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
31
+ default: D[K];
32
+ }> : P[K];
33
+ };
34
+ type __VLS_Prettify<T> = {
35
+ [K in keyof T]: T[K];
36
+ } & {};
37
+ type __VLS_WithTemplateSlots<T, S> = T & {
38
+ new (): {
39
+ $slots: S;
40
+ };
41
+ };
@@ -0,0 +1 @@
1
+ export { default as InputSelectMulti } from './PdapInputSelectMulti.vue';
@@ -0,0 +1,12 @@
1
+ export interface PdapSelectOption {
2
+ value: string;
3
+ label: string;
4
+ }
5
+ export interface PdapInputSelectProps {
6
+ id: string;
7
+ label?: string;
8
+ name: string;
9
+ placeholder?: string;
10
+ position?: 'top' | 'bottom';
11
+ options: PdapSelectOption[];
12
+ }
@@ -1,7 +1,10 @@
1
+ import { Component } from 'node_modules/vue-demi/lib';
2
+ import type { IconDefinition } from '@fortawesome/fontawesome-svg-core';
1
3
  export interface PdapLinkData {
2
4
  href?: string;
3
5
  path?: string;
4
- text: string;
6
+ text?: string;
7
+ icon?: Component | IconDefinition;
5
8
  }
6
9
  export interface PdapNavState {
7
10
  isExpanded: boolean;
@@ -10,6 +10,7 @@ export { InputPassword } from './InputPassword';
10
10
  export { InputRadio } from './InputRadio';
11
11
  export { RadioGroup } from './InputRadioGroup';
12
12
  export { InputSelect } from './InputSelect';
13
+ export { InputSelectMulti } from './InputSelectMulti';
13
14
  export { InputText } from './InputText';
14
15
  export { InputTextArea } from './InputTextArea';
15
16
  export { Header } from './Header';
@@ -20,3 +21,4 @@ export { Dropdown } from './Dropdown';
20
21
  export { Breadcrumbs } from './Breadcrumbs';
21
22
  export { Spinner } from './Spinner';
22
23
  export { RecordTypeIcon } from './RecordTypeIcon';
24
+ export { AsyncTypeahead } from './AsyncTypeahead';
@@ -0,0 +1,2 @@
1
+ declare const _default: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}, {}>;
2
+ export default _default;