UNPKG

18.6 kBTypeScriptView Raw
1import * as React from "react";
2import { AbstractPureComponent2 } from "../../common";
3import { Props } from "../../common/props";
4export declare type TextProps = ITextProps;
5/** @deprecated use TextProps */
6export interface ITextProps extends Props {
7 children?: React.ReactNode;
8 /**
9 * Indicates that this component should be truncated with an ellipsis if it overflows its container.
10 * The `title` attribute will also be added when content overflows to show the full text of the children on hover.
11 *
12 * @default false
13 */
14 ellipsize?: boolean;
15 /**
16 * HTML tag name to use for rendered element.
17 *
18 * @default "div"
19 */
20 tagName?: keyof JSX.IntrinsicElements;
21 /**
22 * HTML title of the element
23 */
24 title?: string;
25}
26export interface ITextState {
27 textContent: string;
28 isContentOverflowing: boolean;
29}
30/**
31 * Text component.
32 *
33 * @see https://blueprintjs.com/docs/#core/components/text
34 */
35export declare class Text extends AbstractPureComponent2<TextProps & Omit<React.HTMLAttributes<HTMLElement>, "title">, ITextState> {
36 static displayName: string;
37 static defaultProps: Partial<TextProps>;
38 state: ITextState;
39 private textRef;
40 componentDidMount(): void;
41 componentDidUpdate(): void;
42 render(): React.DOMElement<{
43 className: string;
44 ref: (ref: HTMLElement | null) => HTMLElement | null;
45 title: string | undefined;
46 onClick?: React.MouseEventHandler<HTMLElement> | undefined;
47 property?: string | undefined;
48 style?: React.CSSProperties | undefined;
49 translate?: "yes" | "no" | undefined;
50 defaultChecked?: boolean | undefined;
51 defaultValue?: string | number | readonly string[] | undefined;
52 suppressContentEditableWarning?: boolean | undefined;
53 suppressHydrationWarning?: boolean | undefined;
54 accessKey?: string | undefined;
55 contentEditable?: (boolean | "true" | "false") | "inherit" | undefined;
56 contextMenu?: string | undefined;
57 dir?: string | undefined;
58 draggable?: (boolean | "true" | "false") | undefined;
59 hidden?: boolean | undefined;
60 id?: string | undefined;
61 lang?: string | undefined;
62 placeholder?: string | undefined;
63 slot?: string | undefined;
64 spellCheck?: (boolean | "true" | "false") | undefined;
65 tabIndex?: number | undefined;
66 radioGroup?: string | undefined;
67 role?: React.AriaRole | undefined;
68 about?: string | undefined;
69 datatype?: string | undefined;
70 inlist?: any;
71 prefix?: string | undefined;
72 resource?: string | undefined;
73 typeof?: string | undefined;
74 vocab?: string | undefined;
75 autoCapitalize?: string | undefined;
76 autoCorrect?: string | undefined;
77 autoSave?: string | undefined;
78 color?: string | undefined;
79 itemProp?: string | undefined;
80 itemScope?: boolean | undefined;
81 itemType?: string | undefined;
82 itemID?: string | undefined;
83 itemRef?: string | undefined;
84 results?: number | undefined;
85 security?: string | undefined;
86 unselectable?: "on" | "off" | undefined;
87 inputMode?: "none" | "text" | "search" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
88 is?: string | undefined;
89 'aria-activedescendant'?: string | undefined;
90 'aria-atomic'?: boolean | "true" | "false" | undefined;
91 'aria-autocomplete'?: "none" | "list" | "inline" | "both" | undefined;
92 'aria-busy'?: boolean | "true" | "false" | undefined;
93 'aria-checked'?: boolean | "true" | "false" | "mixed" | undefined;
94 'aria-colcount'?: number | undefined;
95 'aria-colindex'?: number | undefined;
96 'aria-colspan'?: number | undefined;
97 'aria-controls'?: string | undefined;
98 'aria-current'?: boolean | "time" | "location" | "true" | "false" | "page" | "step" | "date" | undefined;
99 'aria-describedby'?: string | undefined;
100 'aria-details'?: string | undefined;
101 'aria-disabled'?: boolean | "true" | "false" | undefined;
102 'aria-dropeffect'?: "none" | "link" | "move" | "copy" | "execute" | "popup" | undefined;
103 'aria-errormessage'?: string | undefined;
104 'aria-expanded'?: boolean | "true" | "false" | undefined;
105 'aria-flowto'?: string | undefined;
106 'aria-grabbed'?: boolean | "true" | "false" | undefined;
107 'aria-haspopup'?: boolean | "grid" | "menu" | "tree" | "true" | "false" | "dialog" | "listbox" | undefined;
108 'aria-hidden'?: boolean | "true" | "false" | undefined;
109 'aria-invalid'?: boolean | "true" | "false" | "grammar" | "spelling" | undefined;
110 'aria-keyshortcuts'?: string | undefined;
111 'aria-label'?: string | undefined;
112 'aria-labelledby'?: string | undefined;
113 'aria-level'?: number | undefined;
114 'aria-live'?: "off" | "assertive" | "polite" | undefined;
115 'aria-modal'?: boolean | "true" | "false" | undefined;
116 'aria-multiline'?: boolean | "true" | "false" | undefined;
117 'aria-multiselectable'?: boolean | "true" | "false" | undefined;
118 'aria-orientation'?: "horizontal" | "vertical" | undefined;
119 'aria-owns'?: string | undefined;
120 'aria-placeholder'?: string | undefined;
121 'aria-posinset'?: number | undefined;
122 'aria-pressed'?: boolean | "true" | "false" | "mixed" | undefined;
123 'aria-readonly'?: boolean | "true" | "false" | undefined;
124 'aria-relevant'?: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals" | undefined;
125 'aria-required'?: boolean | "true" | "false" | undefined;
126 'aria-roledescription'?: string | undefined;
127 'aria-rowcount'?: number | undefined;
128 'aria-rowindex'?: number | undefined;
129 'aria-rowspan'?: number | undefined;
130 'aria-selected'?: boolean | "true" | "false" | undefined;
131 'aria-setsize'?: number | undefined;
132 'aria-sort'?: "none" | "ascending" | "descending" | "other" | undefined;
133 'aria-valuemax'?: number | undefined;
134 'aria-valuemin'?: number | undefined;
135 'aria-valuenow'?: number | undefined;
136 'aria-valuetext'?: string | undefined;
137 dangerouslySetInnerHTML?: {
138 __html: string;
139 } | undefined;
140 onCopy?: React.ClipboardEventHandler<HTMLElement> | undefined;
141 onCopyCapture?: React.ClipboardEventHandler<HTMLElement> | undefined;
142 onCut?: React.ClipboardEventHandler<HTMLElement> | undefined;
143 onCutCapture?: React.ClipboardEventHandler<HTMLElement> | undefined;
144 onPaste?: React.ClipboardEventHandler<HTMLElement> | undefined;
145 onPasteCapture?: React.ClipboardEventHandler<HTMLElement> | undefined;
146 onCompositionEnd?: React.CompositionEventHandler<HTMLElement> | undefined;
147 onCompositionEndCapture?: React.CompositionEventHandler<HTMLElement> | undefined;
148 onCompositionStart?: React.CompositionEventHandler<HTMLElement> | undefined;
149 onCompositionStartCapture?: React.CompositionEventHandler<HTMLElement> | undefined;
150 onCompositionUpdate?: React.CompositionEventHandler<HTMLElement> | undefined;
151 onCompositionUpdateCapture?: React.CompositionEventHandler<HTMLElement> | undefined;
152 onFocus?: React.FocusEventHandler<HTMLElement> | undefined;
153 onFocusCapture?: React.FocusEventHandler<HTMLElement> | undefined;
154 onBlur?: React.FocusEventHandler<HTMLElement> | undefined;
155 onBlurCapture?: React.FocusEventHandler<HTMLElement> | undefined;
156 onChange?: React.FormEventHandler<HTMLElement> | undefined;
157 onChangeCapture?: React.FormEventHandler<HTMLElement> | undefined;
158 onBeforeInput?: React.FormEventHandler<HTMLElement> | undefined;
159 onBeforeInputCapture?: React.FormEventHandler<HTMLElement> | undefined;
160 onInput?: React.FormEventHandler<HTMLElement> | undefined;
161 onInputCapture?: React.FormEventHandler<HTMLElement> | undefined;
162 onReset?: React.FormEventHandler<HTMLElement> | undefined;
163 onResetCapture?: React.FormEventHandler<HTMLElement> | undefined;
164 onSubmit?: React.FormEventHandler<HTMLElement> | undefined;
165 onSubmitCapture?: React.FormEventHandler<HTMLElement> | undefined;
166 onInvalid?: React.FormEventHandler<HTMLElement> | undefined;
167 onInvalidCapture?: React.FormEventHandler<HTMLElement> | undefined;
168 onLoad?: React.ReactEventHandler<HTMLElement> | undefined;
169 onLoadCapture?: React.ReactEventHandler<HTMLElement> | undefined;
170 onError?: React.ReactEventHandler<HTMLElement> | undefined;
171 onErrorCapture?: React.ReactEventHandler<HTMLElement> | undefined;
172 onKeyDown?: React.KeyboardEventHandler<HTMLElement> | undefined;
173 onKeyDownCapture?: React.KeyboardEventHandler<HTMLElement> | undefined;
174 onKeyPress?: React.KeyboardEventHandler<HTMLElement> | undefined;
175 onKeyPressCapture?: React.KeyboardEventHandler<HTMLElement> | undefined;
176 onKeyUp?: React.KeyboardEventHandler<HTMLElement> | undefined;
177 onKeyUpCapture?: React.KeyboardEventHandler<HTMLElement> | undefined;
178 onAbort?: React.ReactEventHandler<HTMLElement> | undefined;
179 onAbortCapture?: React.ReactEventHandler<HTMLElement> | undefined;
180 onCanPlay?: React.ReactEventHandler<HTMLElement> | undefined;
181 onCanPlayCapture?: React.ReactEventHandler<HTMLElement> | undefined;
182 onCanPlayThrough?: React.ReactEventHandler<HTMLElement> | undefined;
183 onCanPlayThroughCapture?: React.ReactEventHandler<HTMLElement> | undefined;
184 onDurationChange?: React.ReactEventHandler<HTMLElement> | undefined;
185 onDurationChangeCapture?: React.ReactEventHandler<HTMLElement> | undefined;
186 onEmptied?: React.ReactEventHandler<HTMLElement> | undefined;
187 onEmptiedCapture?: React.ReactEventHandler<HTMLElement> | undefined;
188 onEncrypted?: React.ReactEventHandler<HTMLElement> | undefined;
189 onEncryptedCapture?: React.ReactEventHandler<HTMLElement> | undefined;
190 onEnded?: React.ReactEventHandler<HTMLElement> | undefined;
191 onEndedCapture?: React.ReactEventHandler<HTMLElement> | undefined;
192 onLoadedData?: React.ReactEventHandler<HTMLElement> | undefined;
193 onLoadedDataCapture?: React.ReactEventHandler<HTMLElement> | undefined;
194 onLoadedMetadata?: React.ReactEventHandler<HTMLElement> | undefined;
195 onLoadedMetadataCapture?: React.ReactEventHandler<HTMLElement> | undefined;
196 onLoadStart?: React.ReactEventHandler<HTMLElement> | undefined;
197 onLoadStartCapture?: React.ReactEventHandler<HTMLElement> | undefined;
198 onPause?: React.ReactEventHandler<HTMLElement> | undefined;
199 onPauseCapture?: React.ReactEventHandler<HTMLElement> | undefined;
200 onPlay?: React.ReactEventHandler<HTMLElement> | undefined;
201 onPlayCapture?: React.ReactEventHandler<HTMLElement> | undefined;
202 onPlaying?: React.ReactEventHandler<HTMLElement> | undefined;
203 onPlayingCapture?: React.ReactEventHandler<HTMLElement> | undefined;
204 onProgress?: React.ReactEventHandler<HTMLElement> | undefined;
205 onProgressCapture?: React.ReactEventHandler<HTMLElement> | undefined;
206 onRateChange?: React.ReactEventHandler<HTMLElement> | undefined;
207 onRateChangeCapture?: React.ReactEventHandler<HTMLElement> | undefined;
208 onSeeked?: React.ReactEventHandler<HTMLElement> | undefined;
209 onSeekedCapture?: React.ReactEventHandler<HTMLElement> | undefined;
210 onSeeking?: React.ReactEventHandler<HTMLElement> | undefined;
211 onSeekingCapture?: React.ReactEventHandler<HTMLElement> | undefined;
212 onStalled?: React.ReactEventHandler<HTMLElement> | undefined;
213 onStalledCapture?: React.ReactEventHandler<HTMLElement> | undefined;
214 onSuspend?: React.ReactEventHandler<HTMLElement> | undefined;
215 onSuspendCapture?: React.ReactEventHandler<HTMLElement> | undefined;
216 onTimeUpdate?: React.ReactEventHandler<HTMLElement> | undefined;
217 onTimeUpdateCapture?: React.ReactEventHandler<HTMLElement> | undefined;
218 onVolumeChange?: React.ReactEventHandler<HTMLElement> | undefined;
219 onVolumeChangeCapture?: React.ReactEventHandler<HTMLElement> | undefined;
220 onWaiting?: React.ReactEventHandler<HTMLElement> | undefined;
221 onWaitingCapture?: React.ReactEventHandler<HTMLElement> | undefined;
222 onAuxClick?: React.MouseEventHandler<HTMLElement> | undefined;
223 onAuxClickCapture?: React.MouseEventHandler<HTMLElement> | undefined;
224 onClickCapture?: React.MouseEventHandler<HTMLElement> | undefined;
225 onContextMenu?: React.MouseEventHandler<HTMLElement> | undefined;
226 onContextMenuCapture?: React.MouseEventHandler<HTMLElement> | undefined;
227 onDoubleClick?: React.MouseEventHandler<HTMLElement> | undefined;
228 onDoubleClickCapture?: React.MouseEventHandler<HTMLElement> | undefined;
229 onDrag?: React.DragEventHandler<HTMLElement> | undefined;
230 onDragCapture?: React.DragEventHandler<HTMLElement> | undefined;
231 onDragEnd?: React.DragEventHandler<HTMLElement> | undefined;
232 onDragEndCapture?: React.DragEventHandler<HTMLElement> | undefined;
233 onDragEnter?: React.DragEventHandler<HTMLElement> | undefined;
234 onDragEnterCapture?: React.DragEventHandler<HTMLElement> | undefined;
235 onDragExit?: React.DragEventHandler<HTMLElement> | undefined;
236 onDragExitCapture?: React.DragEventHandler<HTMLElement> | undefined;
237 onDragLeave?: React.DragEventHandler<HTMLElement> | undefined;
238 onDragLeaveCapture?: React.DragEventHandler<HTMLElement> | undefined;
239 onDragOver?: React.DragEventHandler<HTMLElement> | undefined;
240 onDragOverCapture?: React.DragEventHandler<HTMLElement> | undefined;
241 onDragStart?: React.DragEventHandler<HTMLElement> | undefined;
242 onDragStartCapture?: React.DragEventHandler<HTMLElement> | undefined;
243 onDrop?: React.DragEventHandler<HTMLElement> | undefined;
244 onDropCapture?: React.DragEventHandler<HTMLElement> | undefined;
245 onMouseDown?: React.MouseEventHandler<HTMLElement> | undefined;
246 onMouseDownCapture?: React.MouseEventHandler<HTMLElement> | undefined;
247 onMouseEnter?: React.MouseEventHandler<HTMLElement> | undefined;
248 onMouseLeave?: React.MouseEventHandler<HTMLElement> | undefined;
249 onMouseMove?: React.MouseEventHandler<HTMLElement> | undefined;
250 onMouseMoveCapture?: React.MouseEventHandler<HTMLElement> | undefined;
251 onMouseOut?: React.MouseEventHandler<HTMLElement> | undefined;
252 onMouseOutCapture?: React.MouseEventHandler<HTMLElement> | undefined;
253 onMouseOver?: React.MouseEventHandler<HTMLElement> | undefined;
254 onMouseOverCapture?: React.MouseEventHandler<HTMLElement> | undefined;
255 onMouseUp?: React.MouseEventHandler<HTMLElement> | undefined;
256 onMouseUpCapture?: React.MouseEventHandler<HTMLElement> | undefined;
257 onSelect?: React.ReactEventHandler<HTMLElement> | undefined;
258 onSelectCapture?: React.ReactEventHandler<HTMLElement> | undefined;
259 onTouchCancel?: React.TouchEventHandler<HTMLElement> | undefined;
260 onTouchCancelCapture?: React.TouchEventHandler<HTMLElement> | undefined;
261 onTouchEnd?: React.TouchEventHandler<HTMLElement> | undefined;
262 onTouchEndCapture?: React.TouchEventHandler<HTMLElement> | undefined;
263 onTouchMove?: React.TouchEventHandler<HTMLElement> | undefined;
264 onTouchMoveCapture?: React.TouchEventHandler<HTMLElement> | undefined;
265 onTouchStart?: React.TouchEventHandler<HTMLElement> | undefined;
266 onTouchStartCapture?: React.TouchEventHandler<HTMLElement> | undefined;
267 onPointerDown?: React.PointerEventHandler<HTMLElement> | undefined;
268 onPointerDownCapture?: React.PointerEventHandler<HTMLElement> | undefined;
269 onPointerMove?: React.PointerEventHandler<HTMLElement> | undefined;
270 onPointerMoveCapture?: React.PointerEventHandler<HTMLElement> | undefined;
271 onPointerUp?: React.PointerEventHandler<HTMLElement> | undefined;
272 onPointerUpCapture?: React.PointerEventHandler<HTMLElement> | undefined;
273 onPointerCancel?: React.PointerEventHandler<HTMLElement> | undefined;
274 onPointerCancelCapture?: React.PointerEventHandler<HTMLElement> | undefined;
275 onPointerEnter?: React.PointerEventHandler<HTMLElement> | undefined;
276 onPointerEnterCapture?: React.PointerEventHandler<HTMLElement> | undefined;
277 onPointerLeave?: React.PointerEventHandler<HTMLElement> | undefined;
278 onPointerLeaveCapture?: React.PointerEventHandler<HTMLElement> | undefined;
279 onPointerOver?: React.PointerEventHandler<HTMLElement> | undefined;
280 onPointerOverCapture?: React.PointerEventHandler<HTMLElement> | undefined;
281 onPointerOut?: React.PointerEventHandler<HTMLElement> | undefined;
282 onPointerOutCapture?: React.PointerEventHandler<HTMLElement> | undefined;
283 onGotPointerCapture?: React.PointerEventHandler<HTMLElement> | undefined;
284 onGotPointerCaptureCapture?: React.PointerEventHandler<HTMLElement> | undefined;
285 onLostPointerCapture?: React.PointerEventHandler<HTMLElement> | undefined;
286 onLostPointerCaptureCapture?: React.PointerEventHandler<HTMLElement> | undefined;
287 onScroll?: React.UIEventHandler<HTMLElement> | undefined;
288 onScrollCapture?: React.UIEventHandler<HTMLElement> | undefined;
289 onWheel?: React.WheelEventHandler<HTMLElement> | undefined;
290 onWheelCapture?: React.WheelEventHandler<HTMLElement> | undefined;
291 onAnimationStart?: React.AnimationEventHandler<HTMLElement> | undefined;
292 onAnimationStartCapture?: React.AnimationEventHandler<HTMLElement> | undefined;
293 onAnimationEnd?: React.AnimationEventHandler<HTMLElement> | undefined;
294 onAnimationEndCapture?: React.AnimationEventHandler<HTMLElement> | undefined;
295 onAnimationIteration?: React.AnimationEventHandler<HTMLElement> | undefined;
296 onAnimationIterationCapture?: React.AnimationEventHandler<HTMLElement> | undefined;
297 onTransitionEnd?: React.TransitionEventHandler<HTMLElement> | undefined;
298 onTransitionEndCapture?: React.TransitionEventHandler<HTMLElement> | undefined;
299 }, HTMLElement>;
300 private update;
301}