This repository has been archived by the owner on Aug 2, 2023. It is now read-only.
/
iwarningoptions.yml
123 lines (121 loc) · 3.88 KB
/
iwarningoptions.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
### YamlMime:TSType
name: IWarningOptions
uid: '@fluentui/react-hooks!IWarningOptions:interface'
package: '@fluentui/react-hooks!'
fullName: IWarningOptions
summary: ''
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
- name: conditionallyRequired
uid: '@fluentui/react-hooks!IWarningOptions#conditionallyRequired:member'
package: '@fluentui/react-hooks!'
fullName: conditionallyRequired
summary: Warns when props are required if a condition is met
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: |-
conditionallyRequired?: {
requiredProps: string[];
conditionalPropName: string;
condition: boolean;
}[];
return:
type: |-
{
requiredProps: string[];
conditionalPropName: string;
condition: boolean;
}[]
- name: controlledUsage
uid: '@fluentui/react-hooks!IWarningOptions#controlledUsage:member'
package: '@fluentui/react-hooks!'
fullName: controlledUsage
summary: >-
Check for and warn on the following error conditions with a form
component: - A value prop is provided (indicated it's being used as
controlled) without a change handler, and the component is not read-only -
Both the value and defaultValue props are provided - The component is
attempting to switch between controlled and uncontrolled
The messages mimic the warnings React gives for these error conditions on
input elements. The warning will only be displayed once per component
instance.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: >-
controlledUsage?: Pick<IWarnControlledUsageParams<P>, 'valueProp' |
'defaultValueProp' | 'onChangeProp' | 'readOnlyProp'>;
return:
type: >-
Pick<IWarnControlledUsageParams<P>, 'valueProp' |
'defaultValueProp' | 'onChangeProp' | 'readOnlyProp'>
- name: deprecations
uid: '@fluentui/react-hooks!IWarningOptions#deprecations:member'
package: '@fluentui/react-hooks!'
fullName: deprecations
summary: >-
Warns when deprecated props are being used. Each key is a prop name and
each value is either undefined or a replacement prop name.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'deprecations?: ISettingsMap<P>;'
return:
type: ISettingsMap<P>
- name: mutuallyExclusive
uid: '@fluentui/react-hooks!IWarningOptions#mutuallyExclusive:member'
package: '@fluentui/react-hooks!'
fullName: mutuallyExclusive
summary: >-
Warns when two props which are mutually exclusive are both being used. The
key is one prop name and the value is the other.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'mutuallyExclusive?: ISettingsMap<P>;'
return:
type: ISettingsMap<P>
- name: name
uid: '@fluentui/react-hooks!IWarningOptions#name:member'
package: '@fluentui/react-hooks!'
fullName: name
summary: Name of the component
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
return:
type: string
- name: other
uid: '@fluentui/react-hooks!IWarningOptions#other:member'
package: '@fluentui/react-hooks!'
fullName: other
summary: Generic messages
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'other?: string[];'
return:
type: 'string[]'
- name: props
uid: '@fluentui/react-hooks!IWarningOptions#props:member'
package: '@fluentui/react-hooks!'
fullName: props
summary: Current component props
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'props: P;'
return:
type: P