@instructure/ui-tag 8.13.1-snapshot.9 → 8.14.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.
Files changed (23) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/es/Tag/TagLocator.js +2 -1
  3. package/es/Tag/__examples__/Tag.examples.js +1 -1
  4. package/es/Tag/index.js +13 -8
  5. package/es/Tag/props.js +0 -22
  6. package/lib/Tag/TagLocator.js +1 -0
  7. package/lib/Tag/__examples__/Tag.examples.js +1 -1
  8. package/lib/Tag/index.js +15 -8
  9. package/lib/Tag/props.js +0 -22
  10. package/package.json +15 -16
  11. package/src/Tag/__examples__/Tag.examples.ts +6 -3
  12. package/src/Tag/index.tsx +16 -15
  13. package/src/Tag/props.ts +21 -18
  14. package/tsconfig.build.json +19 -2
  15. package/tsconfig.build.tsbuildinfo +1 -0
  16. package/types/Tag/TagLocator.d.ts +52 -52
  17. package/types/Tag/__examples__/Tag.examples.d.ts +3 -9
  18. package/types/Tag/__examples__/Tag.examples.d.ts.map +1 -1
  19. package/types/Tag/index.d.ts +11 -8
  20. package/types/Tag/index.d.ts.map +1 -1
  21. package/types/Tag/props.d.ts +20 -2
  22. package/types/Tag/props.d.ts.map +1 -1
  23. package/LICENSE.md +0 -27
package/types/Tag/TagLocator.d.ts CHANGED
@@ -22,25 +22,15 @@ export declare const TagLocator: {
22
22
  toString: (maxLength?: number | undefined, options?: {
23
23
  highlight: boolean;
24
24
  } | undefined) => string;
25
- contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
26
- children: (selector: string) => Element[];
27
- title: () => string | null | undefined;
28
- id: () => string;
29
- tagName: () => string;
30
- getAttribute: (qualifiedName: string) => string | null;
31
- getBoundingClientRect: () => DOMRect;
32
- matches: (selector: string | undefined) => boolean;
33
25
  visible: () => boolean;
34
- value: () => string | null;
35
- disabled: () => string | null;
36
- role: () => string | null;
37
- label: () => string | null | undefined;
38
26
  getId: () => string;
39
27
  getOwnerWindow: () => (Window & typeof globalThis) | null;
40
28
  getOwnerDocument: () => Document;
41
29
  getComputedStyle: () => CSSStyleDeclaration;
42
30
  getTagName: () => string;
31
+ tagName: () => string;
43
32
  typeIn: (text: string) => Promise<void>;
33
+ getAttribute: (qualifiedName: string) => string | null;
44
34
  getDOMNode: () => Element;
45
35
  node: () => Element;
46
36
  debug: (maxLength?: number | undefined, options?: {
@@ -50,6 +40,7 @@ export declare const TagLocator: {
50
40
  getTextContent: () => string | null;
51
41
  getParentNode: () => ParentNode | null;
52
42
  parent: () => ParentNode | null;
43
+ getBoundingClientRect: () => DOMRect;
53
44
  rect: () => DOMRect;
54
45
  hasClass: (classname: string) => boolean;
55
46
  containsFocus: () => boolean;
@@ -61,17 +52,25 @@ export declare const TagLocator: {
61
52
  exists: () => boolean;
62
53
  text: () => string | null;
63
54
  empty: () => boolean;
55
+ contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
64
56
  descendants: (selector: string) => Element[];
65
57
  ancestors: (selector: string) => ParentNode[];
66
58
  attribute: (qualifiedName: string) => string | null;
67
59
  style: (property: string) => string;
68
60
  classNames: () => string[];
61
+ id: () => string;
62
+ matches: (selector: string | undefined) => boolean;
69
63
  checked: () => any;
70
64
  selected: () => any;
65
+ disabled: () => string | null;
71
66
  readonly: () => any;
67
+ role: () => string | null;
68
+ value: () => string | null;
69
+ label: () => string | null | undefined;
70
+ title: () => string | null | undefined;
71
+ children: (selector: string) => Element[];
72
72
  parents: (selector: string) => ParentNode[];
73
73
  } & {
74
- scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
75
74
  copy: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
76
75
  cut: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
77
76
  paste: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -109,6 +108,7 @@ export declare const TagLocator: {
109
108
  touchEnd: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
110
109
  touchMove: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
111
110
  touchStart: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
111
+ scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
112
112
  wheel: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
113
113
  abort: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
114
114
  canPlay: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -161,25 +161,15 @@ export declare const TagLocator: {
161
161
  toString: (maxLength?: number | undefined, options?: {
162
162
  highlight: boolean;
163
163
  } | undefined) => string;
164
- contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
165
- children: (selector: string) => Element[];
166
- title: () => string | null | undefined;
167
- id: () => string;
168
- tagName: () => string;
169
- getAttribute: (qualifiedName: string) => string | null;
170
- getBoundingClientRect: () => DOMRect;
171
- matches: (selector: string | undefined) => boolean;
172
164
  visible: () => boolean;
173
- value: () => string | null;
174
- disabled: () => string | null;
175
- role: () => string | null;
176
- label: () => string | null | undefined;
177
165
  getId: () => string;
178
166
  getOwnerWindow: () => (Window & typeof globalThis) | null;
179
167
  getOwnerDocument: () => Document;
180
168
  getComputedStyle: () => CSSStyleDeclaration;
181
169
  getTagName: () => string;
170
+ tagName: () => string;
182
171
  typeIn: (text: string) => Promise<void>;
172
+ getAttribute: (qualifiedName: string) => string | null;
183
173
  getDOMNode: () => Element;
184
174
  node: () => Element;
185
175
  debug: (maxLength?: number | undefined, options?: {
@@ -189,6 +179,7 @@ export declare const TagLocator: {
189
179
  getTextContent: () => string | null;
190
180
  getParentNode: () => ParentNode | null;
191
181
  parent: () => ParentNode | null;
182
+ getBoundingClientRect: () => DOMRect;
192
183
  rect: () => DOMRect;
193
184
  hasClass: (classname: string) => boolean;
194
185
  containsFocus: () => boolean;
@@ -200,17 +191,25 @@ export declare const TagLocator: {
200
191
  exists: () => boolean;
201
192
  text: () => string | null;
202
193
  empty: () => boolean;
194
+ contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
203
195
  descendants: (selector: string) => Element[];
204
196
  ancestors: (selector: string) => ParentNode[];
205
197
  attribute: (qualifiedName: string) => string | null;
206
198
  style: (property: string) => string;
207
199
  classNames: () => string[];
200
+ id: () => string;
201
+ matches: (selector: string | undefined) => boolean;
208
202
  checked: () => any;
209
203
  selected: () => any;
204
+ disabled: () => string | null;
210
205
  readonly: () => any;
206
+ role: () => string | null;
207
+ value: () => string | null;
208
+ label: () => string | null | undefined;
209
+ title: () => string | null | undefined;
210
+ children: (selector: string) => Element[];
211
211
  parents: (selector: string) => ParentNode[];
212
212
  } & {
213
- scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
214
213
  copy: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
215
214
  cut: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
216
215
  paste: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -248,6 +247,7 @@ export declare const TagLocator: {
248
247
  touchEnd: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
249
248
  touchMove: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
250
249
  touchStart: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
250
+ scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
251
251
  wheel: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
252
252
  abort: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
253
253
  canPlay: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -300,25 +300,15 @@ export declare const TagLocator: {
300
300
  toString: (maxLength?: number | undefined, options?: {
301
301
  highlight: boolean;
302
302
  } | undefined) => string;
303
- contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
304
- children: (selector: string) => Element[];
305
- title: () => string | null | undefined;
306
- id: () => string;
307
- tagName: () => string;
308
- getAttribute: (qualifiedName: string) => string | null;
309
- getBoundingClientRect: () => DOMRect;
310
- matches: (selector: string | undefined) => boolean;
311
303
  visible: () => boolean;
312
- value: () => string | null;
313
- disabled: () => string | null;
314
- role: () => string | null;
315
- label: () => string | null | undefined;
316
304
  getId: () => string;
317
305
  getOwnerWindow: () => (Window & typeof globalThis) | null;
318
306
  getOwnerDocument: () => Document;
319
307
  getComputedStyle: () => CSSStyleDeclaration;
320
308
  getTagName: () => string;
309
+ tagName: () => string;
321
310
  typeIn: (text: string) => Promise<void>;
311
+ getAttribute: (qualifiedName: string) => string | null;
322
312
  getDOMNode: () => Element;
323
313
  node: () => Element;
324
314
  debug: (maxLength?: number | undefined, options?: {
@@ -328,6 +318,7 @@ export declare const TagLocator: {
328
318
  getTextContent: () => string | null;
329
319
  getParentNode: () => ParentNode | null;
330
320
  parent: () => ParentNode | null;
321
+ getBoundingClientRect: () => DOMRect;
331
322
  rect: () => DOMRect;
332
323
  hasClass: (classname: string) => boolean;
333
324
  containsFocus: () => boolean;
@@ -339,17 +330,25 @@ export declare const TagLocator: {
339
330
  exists: () => boolean;
340
331
  text: () => string | null;
341
332
  empty: () => boolean;
333
+ contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
342
334
  descendants: (selector: string) => Element[];
343
335
  ancestors: (selector: string) => ParentNode[];
344
336
  attribute: (qualifiedName: string) => string | null;
345
337
  style: (property: string) => string;
346
338
  classNames: () => string[];
339
+ id: () => string;
340
+ matches: (selector: string | undefined) => boolean;
347
341
  checked: () => any;
348
342
  selected: () => any;
343
+ disabled: () => string | null;
349
344
  readonly: () => any;
345
+ role: () => string | null;
346
+ value: () => string | null;
347
+ label: () => string | null | undefined;
348
+ title: () => string | null | undefined;
349
+ children: (selector: string) => Element[];
350
350
  parents: (selector: string) => ParentNode[];
351
351
  } & {
352
- scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
353
352
  copy: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
354
353
  cut: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
355
354
  paste: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -387,6 +386,7 @@ export declare const TagLocator: {
387
386
  touchEnd: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
388
387
  touchMove: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
389
388
  touchStart: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
389
+ scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
390
390
  wheel: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
391
391
  abort: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
392
392
  canPlay: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -439,25 +439,15 @@ export declare const TagLocator: {
439
439
  toString: (maxLength?: number | undefined, options?: {
440
440
  highlight: boolean;
441
441
  } | undefined) => string;
442
- contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
443
- children: (selector: string) => Element[];
444
- title: () => string | null | undefined;
445
- id: () => string;
446
- tagName: () => string;
447
- getAttribute: (qualifiedName: string) => string | null;
448
- getBoundingClientRect: () => DOMRect;
449
- matches: (selector: string | undefined) => boolean;
450
442
  visible: () => boolean;
451
- value: () => string | null;
452
- disabled: () => string | null;
453
- role: () => string | null;
454
- label: () => string | null | undefined;
455
443
  getId: () => string;
456
444
  getOwnerWindow: () => (Window & typeof globalThis) | null;
457
445
  getOwnerDocument: () => Document;
458
446
  getComputedStyle: () => CSSStyleDeclaration;
459
447
  getTagName: () => string;
448
+ tagName: () => string;
460
449
  typeIn: (text: string) => Promise<void>;
450
+ getAttribute: (qualifiedName: string) => string | null;
461
451
  getDOMNode: () => Element;
462
452
  node: () => Element;
463
453
  debug: (maxLength?: number | undefined, options?: {
@@ -467,6 +457,7 @@ export declare const TagLocator: {
467
457
  getTextContent: () => string | null;
468
458
  getParentNode: () => ParentNode | null;
469
459
  parent: () => ParentNode | null;
460
+ getBoundingClientRect: () => DOMRect;
470
461
  rect: () => DOMRect;
471
462
  hasClass: (classname: string) => boolean;
472
463
  containsFocus: () => boolean;
@@ -478,17 +469,25 @@ export declare const TagLocator: {
478
469
  exists: () => boolean;
479
470
  text: () => string | null;
480
471
  empty: () => boolean;
472
+ contains: (elementOrSelector?: string | Element | undefined) => boolean | Element;
481
473
  descendants: (selector: string) => Element[];
482
474
  ancestors: (selector: string) => ParentNode[];
483
475
  attribute: (qualifiedName: string) => string | null;
484
476
  style: (property: string) => string;
485
477
  classNames: () => string[];
478
+ id: () => string;
479
+ matches: (selector: string | undefined) => boolean;
486
480
  checked: () => any;
487
481
  selected: () => any;
482
+ disabled: () => string | null;
488
483
  readonly: () => any;
484
+ role: () => string | null;
485
+ value: () => string | null;
486
+ label: () => string | null | undefined;
487
+ title: () => string | null | undefined;
488
+ children: (selector: string) => Element[];
489
489
  parents: (selector: string) => ParentNode[];
490
490
  } & {
491
- scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
492
491
  copy: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
493
492
  cut: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
494
493
  paste: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
@@ -526,6 +525,7 @@ export declare const TagLocator: {
526
525
  touchEnd: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
527
526
  touchMove: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
528
527
  touchStart: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
528
+ scroll: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
529
529
  wheel: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
530
530
  abort: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
531
531
  canPlay: (init?: import("@instructure/ui-test-queries/src/utils/events").FireEventInit | undefined, options?: Record<string, unknown> | undefined) => Promise<Event>;
package/types/Tag/__examples__/Tag.examples.d.ts CHANGED
@@ -1,11 +1,5 @@
1
- declare const _default: {
2
- sectionProp: string;
3
- propValues: {
4
- text: string[];
5
- };
6
- getComponentProps: (props: any) => {
7
- onClick: () => void;
8
- };
9
- };
1
+ import type { StoryConfig } from '@instructure/ui-test-utils';
2
+ import type { TagProps } from '../props';
3
+ declare const _default: StoryConfig<TagProps>;
10
4
  export default _default;
11
5
  //# sourceMappingURL=Tag.examples.d.ts.map
package/types/Tag/__examples__/Tag.examples.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Tag.examples.d.ts","sourceRoot":"","sources":["../../../src/Tag/__examples__/Tag.examples.ts"],"names":[],"mappings":";;;;;;;;;AAuBA,wBAWC"}
1
+ {"version":3,"file":"Tag.examples.d.ts","sourceRoot":"","sources":["../../../src/Tag/__examples__/Tag.examples.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;;AAExC,wBAU0B"}
package/types/Tag/index.d.ts CHANGED
@@ -1,36 +1,38 @@
1
1
  /** @jsx jsx */
2
- import { Component } from 'react';
2
+ import React, { Component } from 'react';
3
+ import type { ViewProps } from '@instructure/ui-view';
3
4
  import { jsx } from '@instructure/emotion';
4
5
  import type { TagProps } from './props';
5
6
  /**
6
7
  ---
7
8
  category: components
8
9
  ---
10
+ @tsProps
9
11
  **/
10
12
  declare class Tag extends Component<TagProps> {
11
13
  static readonly componentId = "Tag";
12
14
  static allowedProps: readonly (keyof {
13
15
  className?: string | undefined;
14
- text: import("react").ReactNode;
16
+ text: React.ReactNode;
15
17
  title?: string | undefined;
16
18
  disabled?: boolean | undefined;
17
19
  readOnly?: boolean | undefined;
18
20
  dismissible?: boolean | undefined;
19
21
  margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
20
- onClick?: ((...args: any[]) => any) | undefined;
22
+ onClick?: ((event: React.MouseEvent<ViewProps, MouseEvent>) => void) | undefined;
21
23
  elementRef?: ((element: Element | null) => void) | undefined;
22
24
  size?: "small" | "medium" | "large" | undefined;
23
25
  variant?: "default" | "inline" | undefined;
24
26
  })[];
25
27
  static propTypes: import("@instructure/shared-types/types/UtilityTypes").PropValidators<keyof {
26
28
  className?: string | undefined;
27
- text: import("react").ReactNode;
29
+ text: React.ReactNode;
28
30
  title?: string | undefined;
29
31
  disabled?: boolean | undefined;
30
32
  readOnly?: boolean | undefined;
31
33
  dismissible?: boolean | undefined;
32
34
  margin?: import("@instructure/emotion/types/styleUtils/ThemeablePropValues").Spacing | undefined;
33
- onClick?: ((...args: any[]) => any) | undefined;
35
+ onClick?: ((event: React.MouseEvent<ViewProps, MouseEvent>) => void) | undefined;
34
36
  elementRef?: ((element: Element | null) => void) | undefined;
35
37
  size?: "small" | "medium" | "large" | undefined;
36
38
  variant?: "default" | "inline" | undefined;
@@ -42,12 +44,13 @@ declare class Tag extends Component<TagProps> {
42
44
  disabled: boolean;
43
45
  readOnly: boolean;
44
46
  };
47
+ ref: Element | null;
45
48
  componentDidMount(): void;
46
- componentDidUpdate(prevProps: any, prevState: any, snapshot: any): void;
49
+ componentDidUpdate(): void;
47
50
  get focused(): boolean;
48
51
  focus: () => void;
49
- handleClick: (e: any) => void;
50
- handleRef: (node: any) => void;
52
+ handleClick: (e: React.MouseEvent<ViewProps>) => void;
53
+ handleRef: (element: Element | null) => void;
51
54
  render(): jsx.JSX.Element;
52
55
  }
53
56
  export default Tag;
package/types/Tag/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Tag/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAOjC,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGvC;;;;GAIG;AAEH,cAEM,GAAI,SAAQ,SAAS,CAAC,QAAQ,CAAC;IACnC,MAAM,CAAC,QAAQ,CAAC,WAAW,SAAQ;IAEnC,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,iBAAiB;IAKjB,kBAAkB,CAAC,SAAS,KAAA,EAAE,SAAS,KAAA,EAAE,QAAQ,KAAA;IAIjD,IAAI,OAAO,YAGV;IAED,KAAK,aAGJ;IAGD,WAAW,mBASV;IAGD,SAAS,sBAGR;IAED,MAAM;CAsCP;AAED,eAAe,GAAG,CAAA;AAClB,OAAO,EAAE,GAAG,EAAE,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Tag/index.tsx"],"names":[],"mappings":"AAuBA,eAAe;AACf,OAAO,KAAK,EAAE,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIxC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,EAAa,GAAG,EAAE,MAAM,sBAAsB,CAAA;AAIrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAGvC;;;;;GAKG;AAEH,cAEM,GAAI,SAAQ,SAAS,CAAC,QAAQ,CAAC;IACnC,MAAM,CAAC,QAAQ,CAAC,WAAW,SAAQ;IAEnC,MAAM,CAAC,YAAY;;;;;;;;;;;;SAAe;IAClC,MAAM,CAAC,SAAS;;;;;;;;;;;;OAAY;IAC5B,MAAM,CAAC,YAAY;;;;;;MAMlB;IAED,GAAG,EAAE,OAAO,GAAG,IAAI,CAAO;IAE1B,iBAAiB;IAIjB,kBAAkB;IAIlB,IAAI,OAAO,YAEV;IAED,KAAK,aAEJ;IAED,WAAW,MAAO,gBAAgB,CAAC,SAAS,CAAC,UAS5C;IAED,SAAS,YAAa,OAAO,GAAG,IAAI,UAMnC;IAED,MAAM;CAqCP;AAED,eAAe,GAAG,CAAA;AAClB,OAAO,EAAE,GAAG,EAAE,CAAA"}
package/types/Tag/props.d.ts CHANGED
@@ -1,15 +1,33 @@
1
- /// <reference types="react" />
1
+ import React from 'react';
2
+ import type { ViewProps } from '@instructure/ui-view';
2
3
  import type { Spacing, WithStyleProps, ComponentStyle } from '@instructure/emotion';
3
4
  import type { OtherHTMLAttributes, PropValidators, TagTheme } from '@instructure/shared-types';
4
5
  declare type TagOwnProps = {
5
6
  className?: string;
6
7
  text: string | React.ReactNode;
7
8
  title?: string;
9
+ /**
10
+ * Whether or not to disable the tag
11
+ */
8
12
  disabled?: boolean;
13
+ /**
14
+ * Works just like disabled but keeps the same styles as if it were active
15
+ */
9
16
  readOnly?: boolean;
10
17
  dismissible?: boolean;
18
+ /**
19
+ * Valid values are `0`, `none`, `auto`, `xxxx-small`, `xx-small`, `x-small`,
20
+ * `small`, `medium`, `large`, `x-large`, `xx-large`. Apply these values via
21
+ * familiar CSS-like shorthand. For example: `margin="small auto large"`.
22
+ */
11
23
  margin?: Spacing;
12
- onClick?: (...args: any[]) => any;
24
+ /**
25
+ * If you add an onClick prop, Tag renders as a clickable button
26
+ */
27
+ onClick?: (event: React.MouseEvent<ViewProps>) => void;
28
+ /**
29
+ * Provides a reference to the underlying html root element
30
+ */
13
31
  elementRef?: (element: Element | null) => void;
14
32
  size?: 'small' | 'medium' | 'large';
15
33
  variant?: 'default' | 'inline';
package/types/Tag/props.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Tag/props.ts"],"names":[],"mappings":";AA2BA,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,QAAQ,EACT,MAAM,2BAA2B,CAAA;AAElC,aAAK,WAAW,GAAG;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,CAAA;IACjC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,OAAO,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;CAC/B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,WAAW,CAAA;AAEjC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,QAAQ,GAAG,WAAW,GACzB,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAClC,mBAAmB,CAAC,WAAW,CAAC,CAAA;AAElC,aAAK,QAAQ,GAAG,cAAc,CAAC,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC,CAAA;AAEvD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CA6BvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
1
+ {"version":3,"file":"props.d.ts","sourceRoot":"","sources":["../../src/Tag/props.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AACrD,OAAO,KAAK,EACV,OAAO,EACP,cAAc,EACd,cAAc,EACf,MAAM,sBAAsB,CAAA;AAC7B,OAAO,KAAK,EACV,mBAAmB,EACnB,cAAc,EACd,QAAQ,EACT,MAAM,2BAA2B,CAAA;AAElC,aAAK,WAAW,GAAG;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC,SAAS,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,IAAI,CAAA;IACtD;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,KAAK,IAAI,CAAA;IAC9C,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC,OAAO,CAAC,EAAE,SAAS,GAAG,QAAQ,CAAA;CAC/B,CAAA;AAED,aAAK,QAAQ,GAAG,MAAM,WAAW,CAAA;AAEjC,aAAK,eAAe,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAA;AAEhD,aAAK,QAAQ,GAAG,WAAW,GACzB,cAAc,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAClC,mBAAmB,CAAC,WAAW,CAAC,CAAA;AAElC,aAAK,QAAQ,GAAG,cAAc,CAAC,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC,CAAA;AAEvD,QAAA,MAAM,SAAS,EAAE,cAAc,CAAC,QAAQ,CAYvC,CAAA;AAED,QAAA,MAAM,YAAY,EAAE,eAYnB,CAAA;AAED,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAA;AAClC,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAA"}
package/LICENSE.md DELETED
@@ -1,27 +0,0 @@
1
- ---
2
- title: The MIT License (MIT)
3
- category: Getting Started
4
- order: 9
5
- ---
6
-
7
- # The MIT License (MIT)
8
-
9
- Copyright (c) 2015 Instructure, Inc.
10
-
11
- **Permission is hereby granted, free of charge, to any person obtaining a copy
12
- of this software and associated documentation files (the "Software"), to deal
13
- in the Software without restriction, including without limitation the rights
14
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15
- copies of the Software, and to permit persons to whom the Software is
16
- furnished to do so, subject to the following conditions.**
17
-
18
- The above copyright notice and this permission notice shall be included in all
19
- copies or substantial portions of the Software.
20
-
21
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27
- SOFTWARE.