idea-react 2.3.0 → 2.3.1

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.
@@ -0,0 +1,388 @@
1
+ import { Component, DetailedHTMLProps, FC, HTMLAttributes, ImgHTMLAttributes, InputHTMLAttributes, MouseEvent as MouseEvent$1, PropsWithChildren, PropsWithRef, PropsWithoutRef, PureComponent, ReactNode, RefCallback, TimeHTMLAttributes } from "react";
2
+ import { ObservedComponent } from "mobx-react-helper";
3
+ import { TimeData, Timestamp } from "web-utility";
4
+ import { Defer } from "iterable-observer";
5
+ import { LiveProvider } from "react-live";
6
+ import { ButtonProps, DropdownButtonProps, DropdownItemProps, NavProps, OverlayTriggerProps, RowProps, SpinnerProps, TableProps, ToastContainerProps } from "react-bootstrap";
7
+ import { Color, Variant } from "react-bootstrap/esm/types.js";
8
+ import { WrapperProps } from "@react-editor-js/core";
9
+ import { OutputData } from "@editorjs/editorjs";
10
+ //#region source/animate.d.ts
11
+ declare function animate(name: string): RefCallback<Element>;
12
+ //#endregion
13
+ //#region source/Avatar.d.ts
14
+ interface AvatarProps extends ImgHTMLAttributes<HTMLImageElement> {
15
+ size?: number;
16
+ }
17
+ declare const Avatar: FC<AvatarProps>;
18
+ //#endregion
19
+ //#region source/ClickBoundary.d.ts
20
+ type ClickBoundaryProps = PropsWithChildren<{
21
+ onInnerClick?: (event: MouseEvent) => any;
22
+ onOuterClick?: (event: MouseEvent) => any;
23
+ } & DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>>;
24
+ declare class ClickBoundary extends PureComponent<ClickBoundaryProps> {
25
+ root: import("react").RefObject<HTMLDivElement>;
26
+ switchClick: (event: MouseEvent) => void;
27
+ componentDidMount(): void;
28
+ componentWillUnmount(): void;
29
+ render(): import("react").JSX.Element;
30
+ }
31
+ //#endregion
32
+ //#region source/CodeBlock.d.ts
33
+ interface CodeBlockProps extends HTMLAttributes<HTMLPreElement> {
34
+ language: string;
35
+ }
36
+ declare const CodeBlock: FC<CodeBlockProps>;
37
+ //#endregion
38
+ //#region source/color.d.ts
39
+ type VariantColor = Exclude<Color, 'white' | 'muted'>;
40
+ declare const VariantColors: VariantColor[];
41
+ declare function text2color(raw: string, excludeColors?: VariantColor[]): VariantColor;
42
+ //#endregion
43
+ //#region source/Countdown.d.ts
44
+ interface TimeUnit {
45
+ scale: number;
46
+ label: string;
47
+ }
48
+ interface TimeSection {
49
+ value: number;
50
+ label: string;
51
+ }
52
+ interface CountdownProps extends HTMLAttributes<HTMLOListElement> {
53
+ units: TimeUnit[];
54
+ endTime: TimeData;
55
+ itemClassName?: string;
56
+ onEnd?: (endTime: TimeData) => unknown;
57
+ }
58
+ /**
59
+ * Migrate from https://bootstrap.web-cell.dev/#Calendar/CountDown
60
+ */
61
+ declare class Countdown extends ObservedComponent<CountdownProps> {
62
+ static displayName: string;
63
+ accessor rest: number;
64
+ private timer;
65
+ get endTimestamp(): number;
66
+ get timeSections(): TimeSection[];
67
+ tick: () => void;
68
+ stop(): void;
69
+ componentDidMount(): void;
70
+ initTimer(): void;
71
+ componentWillUnmount(): void;
72
+ render(): import("react").JSX.Element;
73
+ }
74
+ //#endregion
75
+ //#region source/Dialog.d.ts
76
+ declare class DialogClose extends Error {
77
+ constructor(message?: string);
78
+ }
79
+ interface DialogProps<T = any> {
80
+ defer?: Defer<T>;
81
+ }
82
+ declare class Dialog<I extends object = {}, O = any> {
83
+ accessor input: I;
84
+ accessor defer: Defer<O> | undefined;
85
+ Component: FC<I>;
86
+ constructor(Factory: FC<I & DialogProps<O>>);
87
+ open(input?: I): Promise<O>;
88
+ }
89
+ //#endregion
90
+ //#region source/Editor.d.ts
91
+ type EditorProps = PropsWithoutRef<WrapperProps & Pick<InputHTMLAttributes<HTMLInputElement>, 'name' | 'required'>>;
92
+ declare class Editor extends Component<EditorProps> {
93
+ static displayName: string;
94
+ private core?;
95
+ accessor innerValue: import("@editorjs/editorjs").OutputData;
96
+ save: () => Promise<import("@editorjs/editorjs").OutputData>;
97
+ render(): import("react").JSX.Element;
98
+ }
99
+ //#endregion
100
+ //#region source/EditorHTML.d.ts
101
+ declare const parser: {
102
+ parse: (blocks: OutputData) => string;
103
+ parseBlock: (block: import("@editorjs/editorjs").OutputBlockData) => {} | undefined;
104
+ };
105
+ interface EditorHTMLProps extends HTMLAttributes<HTMLDivElement> {
106
+ data: OutputData;
107
+ }
108
+ declare const EditorHTML: FC<EditorHTMLProps>;
109
+ //#endregion
110
+ //#region source/HorizontalMarquee/index.d.ts
111
+ type HorizontalMarqueeProps = HTMLAttributes<HTMLDivElement> & Partial<Record<'maxWidth' | 'duration' | 'height', string>>;
112
+ declare const HorizontalMarquee: FC<HorizontalMarqueeProps>;
113
+ declare const HorizontalMarqueeBox: FC<HorizontalMarqueeProps>;
114
+ //#endregion
115
+ //#region source/Icon.d.ts
116
+ type IconProps = PropsWithRef<HTMLAttributes<HTMLSpanElement> & {
117
+ name: string;
118
+ size?: number;
119
+ }>;
120
+ declare const Icon: FC<IconProps>;
121
+ //#endregion
122
+ //#region source/LiveTSX.d.ts
123
+ type LiveTSXProps = Pick<Parameters<typeof LiveProvider>[0], 'scope' | 'children'>;
124
+ declare const LiveTSX: FC<LiveTSXProps>;
125
+ //#endregion
126
+ //#region source/Loading.d.ts
127
+ type LoadingProps = HTMLAttributes<HTMLDivElement>;
128
+ declare const Loading: FC<LoadingProps>;
129
+ //#endregion
130
+ //#region source/MonthCalendar.d.ts
131
+ interface DateData {
132
+ date: TimeData;
133
+ content: ReactNode;
134
+ link?: string;
135
+ }
136
+ interface MonthCalendarProps extends Omit<TableProps, 'variant' | 'onChange' | 'onSelect'>, Pick<ButtonProps, 'variant'> {
137
+ locale?: Navigator['language'];
138
+ value?: DateData[];
139
+ onSelect?: (value: DateData) => any;
140
+ onChange?: (date: Date) => any;
141
+ }
142
+ /**
143
+ * Re-implement from https://github.com/EasyWebApp/BootCell/blob/3d30027a97fe0a8c4ab8fabc8dfef22aede04de7/source/Calendar/MonthCalendar.tsx
144
+ */
145
+ declare class MonthCalendar extends ObservedComponent<MonthCalendarProps> {
146
+ static displayName: string;
147
+ get weekFormatter(): Intl.DateTimeFormat;
148
+ accessor currentDate: Date;
149
+ get dateGrid(): Date[][];
150
+ changeMonth(delta: number): void;
151
+ renderDate: (date: Date) => import("react").JSX.Element;
152
+ render(): import("react").JSX.Element;
153
+ }
154
+ //#endregion
155
+ //#region source/Nameplate.d.ts
156
+ type NameplateProps = PropsWithoutRef<{
157
+ avatar: string;
158
+ name: string;
159
+ }>;
160
+ declare const Nameplate: FC<NameplateProps>;
161
+ //#endregion
162
+ //#region source/OverlayBox.d.ts
163
+ interface OverlayBoxProps extends Omit<OverlayTriggerProps, 'overlay'> {
164
+ title: ReactNode;
165
+ detail?: ReactNode;
166
+ }
167
+ /**
168
+ * ToDo: {@link https://react-bootstrap.github.io/docs/components/overlays#disabled-elements}
169
+ */
170
+ declare const OverlayBox: FC<OverlayBoxProps>;
171
+ //#endregion
172
+ //#region source/PageNav.d.ts
173
+ type HeadingMeta = Record<'id' | 'text', string> & Record<'level' | 'top', number>;
174
+ interface PageNavProps extends NavProps {
175
+ depth?: number;
176
+ onItemClick?: (item: HeadingMeta) => any;
177
+ }
178
+ declare class PageNav extends Component<PageNavProps> {
179
+ static displayName: string;
180
+ accessor list: HeadingMeta[];
181
+ accessor scrollY: number;
182
+ get currentActiveId(): string;
183
+ updateScrollY: () => number;
184
+ componentDidMount(): void;
185
+ componentWillUnmount(): void;
186
+ scrollTo: (meta: HeadingMeta) => () => void;
187
+ renderLink: ({ id, level, text, top }: HeadingMeta) => import("react").JSX.Element;
188
+ render(): import("react").JSX.Element;
189
+ }
190
+ //#endregion
191
+ //#region source/ScrollNav/index.d.ts
192
+ type ScrollNavProps = NavProps;
193
+ /**
194
+ * A horizontal scrolling navigation bar based on Bootstrap's `nav-scroller` pattern.
195
+ * Automatically shows scroll arrow buttons when nav items overflow the container width.
196
+ *
197
+ * @see {@link https://github.com/twbs/bootstrap/blob/main/site/src/assets/examples/offcanvas-navbar/index.astro#L50-L65}
198
+ */
199
+ declare class ScrollNav extends Component<ScrollNavProps> {
200
+ static displayName: string;
201
+ scrollerRef: import("react").RefObject<HTMLDivElement>;
202
+ accessor scrollLeft: number;
203
+ accessor scrollWidth: number;
204
+ accessor clientWidth: number;
205
+ get canScrollLeft(): boolean;
206
+ get canScrollRight(): boolean;
207
+ updateScroll: () => HTMLDivElement;
208
+ private resizeObserver?;
209
+ componentDidMount(): void;
210
+ componentWillUnmount(): void;
211
+ scrollBy: (direction: -1 | 1) => () => void;
212
+ render(): import("react").JSX.Element;
213
+ }
214
+ //#endregion
215
+ //#region source/Select.d.ts
216
+ interface OptionProps extends DropdownItemProps {
217
+ value?: string;
218
+ }
219
+ declare const Option: FC<OptionProps>;
220
+ interface SelectProps extends Omit<OptionProps, 'onChange'>, Pick<DropdownButtonProps, 'variant' | 'menuVariant'> {
221
+ onChange?: (value: string) => any;
222
+ valueRender?: (value: string) => ReactNode;
223
+ }
224
+ declare const Select: FC<SelectProps>;
225
+ //#endregion
226
+ //#region source/ShareBox.d.ts
227
+ declare function elementToImage(element: HTMLElement, type?: string, quality?: number): Promise<string>;
228
+ type ShareBoxProps = HTMLAttributes<HTMLDivElement> & ShareData;
229
+ declare class ShareBox extends Component<ShareBoxProps> {
230
+ static displayName: string;
231
+ root: import("react").RefObject<HTMLDivElement>;
232
+ accessor loading: boolean;
233
+ accessor imageURI: string;
234
+ componentDidMount(): void;
235
+ componentWillUnmount(): void;
236
+ generateImage: () => Promise<void>;
237
+ share: (event: MouseEvent$1<HTMLImageElement>) => Promise<void>;
238
+ render(): import("react").JSX.Element;
239
+ }
240
+ //#endregion
241
+ //#region source/SpinnerButton.d.ts
242
+ interface SpinnerButtonProps extends ButtonProps, Pick<SpinnerProps, 'animation'> {
243
+ loading?: boolean;
244
+ }
245
+ declare const SpinnerButton: FC<SpinnerButtonProps>;
246
+ //#endregion
247
+ //#region source/TableSpinner.d.ts
248
+ interface TableSpinnerProps extends HTMLAttributes<HTMLTableRowElement>, Pick<SpinnerProps, 'animation' | 'variant' | 'size'> {
249
+ colSpan: number;
250
+ }
251
+ declare const TableSpinner: FC<TableSpinnerProps>;
252
+ //#endregion
253
+ //#region source/TextTruncate.d.ts
254
+ interface TextTruncateProps extends HTMLAttributes<HTMLDivElement> {
255
+ rows?: number;
256
+ expandText?: ReactNode;
257
+ collapseText?: ReactNode;
258
+ }
259
+ declare class TextTruncate extends Component<TextTruncateProps> {
260
+ static displayName: string;
261
+ accessor expanded: boolean;
262
+ accessor overflowed: boolean;
263
+ contentRef: import("react").RefObject<HTMLParagraphElement>;
264
+ componentDidMount(): void;
265
+ componentDidUpdate({ rows, children }: TextTruncateProps): void;
266
+ componentWillUnmount(): void;
267
+ checkOverflow: () => void;
268
+ toggle: () => void;
269
+ render(): import("react").JSX.Element;
270
+ }
271
+ //#endregion
272
+ //#region source/Time.d.ts
273
+ interface TimeProps extends Omit<TimeHTMLAttributes<HTMLTimeElement>, 'dateTime'> {
274
+ dateTime: TimeData;
275
+ format?: string;
276
+ }
277
+ declare class Time extends ObservedComponent<TimeProps> {
278
+ static displayName: string;
279
+ updateText(): string;
280
+ accessor timeText: string;
281
+ componentDidMount(): void;
282
+ render(): import("react").JSX.Element;
283
+ }
284
+ //#endregion
285
+ //#region source/TimeDistance.d.ts
286
+ interface TimeDistanceProps extends HTMLAttributes<HTMLTimeElement> {
287
+ date: TimeData;
288
+ unitWords?: Record<string, string>;
289
+ beforeWord?: string;
290
+ afterWord?: string;
291
+ }
292
+ declare const TimeDistance: FC<TimeDistanceProps>;
293
+ //#endregion
294
+ //#region source/Timeline/index.d.ts
295
+ interface TimelineEvent {
296
+ title: string;
297
+ summary?: string;
298
+ time: [TimeData, TimeData?];
299
+ link?: string;
300
+ people?: NameplateProps[];
301
+ }
302
+ interface TimelineProps extends HTMLAttributes<HTMLOListElement> {
303
+ events: TimelineEvent[];
304
+ timeFormat?: string;
305
+ }
306
+ /**
307
+ * @see {@link https://mdbootstrap.com/docs/standard/extended/timeline/#section-timeline-gradient-bg}
308
+ */
309
+ declare const Timeline: FC<TimelineProps>;
310
+ //#endregion
311
+ //#region source/Toast.d.ts
312
+ interface ToastMessage {
313
+ id?: string;
314
+ title?: ReactNode;
315
+ body: ReactNode;
316
+ variant?: Variant;
317
+ delay?: number;
318
+ }
319
+ interface ToastItem extends ToastMessage {
320
+ openedAt: number;
321
+ closedAt?: number;
322
+ resolve?: (value: ToastItem) => void;
323
+ }
324
+ declare class Toast {
325
+ TimeScalar: typeof Timestamp;
326
+ accessor messages: ToastItem[];
327
+ Component: FC<Pick<ToastContainerProps, 'position'>>;
328
+ renderMessage: ({ id, openedAt, title, body, variant, delay }: ToastItem) => import("react").JSX.Element;
329
+ constructor(TimeScalar?: typeof Timestamp);
330
+ open(message: ToastMessage): Promise<ToastItem>;
331
+ close(id: string): void;
332
+ }
333
+ //#endregion
334
+ //#region source/TypeEcho.d.ts
335
+ interface TypeEchoProps extends HTMLAttributes<HTMLPreElement> {
336
+ text: string;
337
+ intervals?: number;
338
+ }
339
+ declare class TypeEcho extends Component<TypeEchoProps> {
340
+ static displayName: string;
341
+ accessor echoed: string;
342
+ init: RefCallback<HTMLPreElement>;
343
+ render(): import("react").JSX.Element;
344
+ }
345
+ //#endregion
346
+ //#region source/UserRank/Address.d.ts
347
+ type UserAddressProps = Partial<Record<'email' | 'website', string>>;
348
+ //#endregion
349
+ //#region source/UserRank/index.d.ts
350
+ interface UserRank extends UserAddressProps {
351
+ id: number | string;
352
+ name: string;
353
+ avatar?: string;
354
+ score: number;
355
+ }
356
+ interface UserRankViewProps extends RowProps {
357
+ title: string;
358
+ rank: UserRank[];
359
+ linkOf?: (user: UserRank) => string;
360
+ }
361
+ declare class UserRankView extends PureComponent<UserRankViewProps> {
362
+ static displayName: string;
363
+ renderMedal: (user: UserRank) => import("react").JSX.Element;
364
+ renderRow: (user: UserRank, index: number, { length }: UserRank[]) => import("react").JSX.Element;
365
+ render(): import("react").JSX.Element;
366
+ }
367
+ //#endregion
368
+ //#region source/VerticalMarquee/index.d.ts
369
+ interface VerticalMarqueeProps extends HTMLAttributes<HTMLDivElement> {
370
+ duration?: string;
371
+ }
372
+ declare const VerticalMarquee: FC<VerticalMarqueeProps>;
373
+ //#endregion
374
+ //#region source/ZodiacBar.d.ts
375
+ declare const ZodiacSigns: string[];
376
+ declare const zodiacOf: (year: number) => string;
377
+ interface ZodiacBarProps extends HTMLAttributes<HTMLOListElement> {
378
+ itemClassName?: string;
379
+ startYear: number;
380
+ endYear?: number;
381
+ itemOf?: (year: number, zodiac: string) => {
382
+ link?: string;
383
+ title?: ReactNode;
384
+ };
385
+ }
386
+ declare const ZodiacBar: FC<ZodiacBarProps>;
387
+ //#endregion
388
+ export { Avatar, AvatarProps, ClickBoundary, ClickBoundaryProps, CodeBlock, CodeBlockProps, Countdown, CountdownProps, DateData, Dialog, DialogClose, DialogProps, Editor, EditorHTML, EditorHTMLProps, EditorProps, HorizontalMarquee, HorizontalMarqueeBox, HorizontalMarqueeProps, Icon, IconProps, LiveTSX, LiveTSXProps, Loading, LoadingProps, MonthCalendar, MonthCalendarProps, Nameplate, NameplateProps, Option, OptionProps, OverlayBox, OverlayBoxProps, PageNav, PageNavProps, ScrollNav, ScrollNavProps, Select, SelectProps, ShareBox, ShareBoxProps, SpinnerButton, SpinnerButtonProps, TableSpinner, TableSpinnerProps, TextTruncate, TextTruncateProps, Time, TimeDistance, TimeDistanceProps, TimeProps, TimeUnit, Timeline, TimelineEvent, TimelineProps, Toast, ToastMessage, TypeEcho, TypeEchoProps, UserRank, UserRankView, UserRankViewProps, VariantColor, VariantColors, VerticalMarquee, VerticalMarqueeProps, ZodiacBar, ZodiacBarProps, ZodiacSigns, animate, elementToImage, parser, text2color, zodiacOf };