@sisense/sdk-ui-vue 2.25.0 → 2.26.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.
@@ -1,57 +0,0 @@
1
- /// <reference types="react" />
2
- import { type TableWidgetProps } from '@sisense/sdk-ui-preact';
3
- import type { PropType } from 'vue';
4
- export { TableWidgetProps };
5
- /**
6
- * The TableWidget component extending the Table component to support widget style options.
7
- *
8
- * @example
9
- * Here's how you can use the TableWidget component in a Vue application:
10
- * ```vue
11
- * <template>
12
- * <TableWidget :props="tableWidgetProps" />
13
- * </template>
14
- *
15
- * <script setup lang="ts">
16
- * import { ref } from 'vue';
17
- * import TableWidget from '@sisense/sdk-ui-vue/TableWidget';
18
- *
19
- * const tableWidgetProps = ref({
20
- * // Configure your TableWidgetProps here
21
- * });
22
- * </script>
23
- * ```
24
- * <img src="media://vue-table-widget-example.png" width="600px" />
25
- * @param props - Table Widget properties
26
- * @returns Widget component representing a table
27
- * @internal
28
- */
29
- export declare const TableWidget: import("vue").DefineComponent<{
30
- bottomSlot: PropType<import("react").ReactNode>;
31
- dataOptions: {
32
- type: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
33
- required: true;
34
- };
35
- dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
36
- description: PropType<string | undefined>;
37
- filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
38
- styleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
39
- title: PropType<string | undefined>;
40
- topSlot: PropType<import("react").ReactNode>;
41
- widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
42
- }, (() => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
43
- [key: string]: any;
44
- }>) | null, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
45
- bottomSlot: PropType<import("react").ReactNode>;
46
- dataOptions: {
47
- type: PropType<import("@sisense/sdk-ui-preact").TableDataOptions>;
48
- required: true;
49
- };
50
- dataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
51
- description: PropType<string | undefined>;
52
- filters: PropType<import("@sisense/sdk-data").FilterRelations | import("@sisense/sdk-data").Filter[] | undefined>;
53
- styleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
54
- title: PropType<string | undefined>;
55
- topSlot: PropType<import("react").ReactNode>;
56
- widgetStyleOptions: PropType<import("@sisense/sdk-ui-preact").TableWidgetStyleOptions | undefined>;
57
- }>>, {}, {}>;
@@ -1,205 +0,0 @@
1
- import type { SisenseContextProviderProps as SisenseContextProviderPropsPreact } from '@sisense/sdk-ui-preact';
2
- import type { PropType } from 'vue';
3
- /**
4
- * Configurations and authentication for Sisense Context.
5
- *
6
- * Use one of the following to authenticate:
7
- *
8
- * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.ssoEnabled | `ssoEnabled`}
9
- * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.token | `token`}
10
- * - {@link @sisense/sdk-ui-vue!SisenseContextProviderProps.wat | `wat`}
11
- */
12
- export interface SisenseContextProviderProps extends SisenseContextProviderPropsPreact {
13
- }
14
- /**
15
- * Sisense Context Provider Component allowing you to connect to
16
- * a Sisense instance and provide that context
17
- * to all Compose SDK components in your application.
18
- *
19
- * @example
20
- * Here's how to use the `SisenseContextProvider` component to wrap your Sisense-enabled application:
21
- * Add SisenseContextProvider to the main component of your app as below and then wrap
22
- * other SDK components inside this component.
23
- * ```vue
24
- * <template>
25
- * <SisenseContextProvider
26
- * :url="sisenseUrl"
27
- * :defaultDataSource="defaultDataSource"
28
- * :ssoEnabled="true"
29
- * :token="authToken"
30
- * :wat="watToken"
31
- * :appConfig="appConfigurations"
32
- * >
33
- * <!-- Your application components here -->
34
- * </SisenseContextProvider>
35
- * </template>
36
- *
37
- * <script>
38
- * import { ref } from 'vue';
39
- * import SisenseContextProvider from './SisenseContextProvider.vue';
40
- *
41
- * export default {
42
- * components: { SisenseContextProvider },
43
- * setup() {
44
- * const sisenseUrl = ref('https://your-sisense-instance.com');
45
- * const defaultDataSource = ref('default_datasource_id');
46
- * const authToken = ref('your_auth_token');
47
- * const watToken = ref('your_wat_token');
48
- * const appConfigurations = ref({});
49
- *
50
- * return { sisenseUrl, defaultDataSource, authToken, watToken, appConfigurations };
51
- * }
52
- * };
53
- * </script>
54
- * ```
55
- *
56
- * @param props - Sisense context provider props
57
- * @returns A Sisense Context Provider Component
58
- * @group Contexts
59
- */
60
- export declare const SisenseContextProvider: import("vue").DefineComponent<{
61
- /**
62
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
63
- *
64
- * @category Sisense App
65
- */
66
- defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
67
- /**
68
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
69
- *
70
- * @category Sisense App
71
- */
72
- url: {
73
- type: PropType<string>;
74
- required: true;
75
- };
76
- /**
77
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
78
- *
79
- * @category Sisense Authentication
80
- */
81
- ssoEnabled: PropType<boolean | undefined>;
82
- /**
83
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
84
- *
85
- * @category Sisense Authentication
86
- */
87
- token: PropType<string | null | undefined>;
88
- /**
89
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
90
- *
91
- * @category Sisense Authentication
92
- */
93
- wat: PropType<string | null | undefined>;
94
- /**
95
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
96
- *
97
- * @category Sisense App
98
- */
99
- appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
100
- /**
101
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
102
- *
103
- * @category Sisense App
104
- * @internal
105
- */
106
- plugins: {
107
- type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
108
- default: () => never[];
109
- };
110
- /**
111
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
112
- *
113
- * @category Sisense Authentication
114
- * @alpha
115
- */
116
- ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
117
- /**
118
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
119
- *
120
- * @category Sisense Authentication
121
- * @alpha
122
- */
123
- ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
124
- /**
125
- * @internal
126
- */
127
- showRuntimeErrors: {
128
- type: PropType<boolean | undefined>;
129
- default: boolean;
130
- };
131
- }, () => import("vue/jsx-runtime").JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
132
- /**
133
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.defaultDataSource}
134
- *
135
- * @category Sisense App
136
- */
137
- defaultDataSource: PropType<import("@sisense/sdk-data").DataSource | undefined>;
138
- /**
139
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.url}
140
- *
141
- * @category Sisense App
142
- */
143
- url: {
144
- type: PropType<string>;
145
- required: true;
146
- };
147
- /**
148
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoEnabled}
149
- *
150
- * @category Sisense Authentication
151
- */
152
- ssoEnabled: PropType<boolean | undefined>;
153
- /**
154
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.token}
155
- *
156
- * @category Sisense Authentication
157
- */
158
- token: PropType<string | null | undefined>;
159
- /**
160
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.wat}
161
- *
162
- * @category Sisense Authentication
163
- */
164
- wat: PropType<string | null | undefined>;
165
- /**
166
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.appConfig}
167
- *
168
- * @category Sisense App
169
- */
170
- appConfig: PropType<import("@sisense/sdk-ui-preact").AppConfig | undefined>;
171
- /**
172
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.plugins}
173
- *
174
- * @category Sisense App
175
- * @internal
176
- */
177
- plugins: {
178
- type: PropType<import("@sisense/sdk-ui-preact").Plugin[] | undefined>;
179
- default: () => never[];
180
- };
181
- /**
182
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoMaxAuthRedirectAttempts}
183
- *
184
- * @category Sisense Authentication
185
- * @alpha
186
- */
187
- ssoMaxAuthRedirectAttempts: PropType<number | undefined>;
188
- /**
189
- * {@inheritDoc @sisense/sdk-ui!SisenseContextProviderProps.ssoRedirectAttemptsTtlMs}
190
- *
191
- * @category Sisense Authentication
192
- * @alpha
193
- */
194
- ssoRedirectAttemptsTtlMs: PropType<number | undefined>;
195
- /**
196
- * @internal
197
- */
198
- showRuntimeErrors: {
199
- type: PropType<boolean | undefined>;
200
- default: boolean;
201
- };
202
- }>>, {
203
- plugins: import("@sisense/sdk-ui-preact").Plugin[] | undefined;
204
- showRuntimeErrors: boolean | undefined;
205
- }, {}>;