Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 | 31x 31x 31x 31x 31x | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json",
"title": "UIF Shared Definitions",
"description": "Shared type definitions used by both Foundation and System schemas",
"definitions": {
"IdentifierName": {
"type": "string",
"pattern": "^[a-zA-Z_$][a-zA-Z0-9_$-]*$",
"description": "Name that becomes a JavaScript identifier. Must start with letter, underscore, or $. May contain letters, numbers, underscores, hyphens, or $. Hyphens are converted to camelCase during code generation (e.g., 'outline-brand' → 'outlineBrand')."
},
"Slot": {
"type": "object",
"description": "Slot definition for content injection",
"properties": {
"name": {
"type": "string",
"description": "Slot identifier ('default' for primary content)"
},
"restrict": {
"type": "array",
"items": { "type": "string" },
"description": "Allowed component types (e.g., ['Tab'] for TabList slots)"
},
"required": {
"type": "boolean",
"description": "If true, at least one child must be provided"
},
"extensions": { "$ref": "#/definitions/Extensions" }
},
"required": ["name"],
"additionalProperties": false
},
"BoundAttribute": {
"type": "object",
"description": "Attribute bound to a component prop",
"properties": {
"prop": {
"type": "string",
"description": "Name of the prop this attribute is bound to"
},
"required": {
"type": "boolean",
"description": "Whether this prop is required"
}
},
"required": ["prop"],
"additionalProperties": false
},
"ConditionalAttribute": {
"type": "object",
"description": "Attribute rendered conditionally",
"properties": {
"when": {
"type": "string",
"description": "Condition expression (e.g., state reference)"
},
"value": {
"type": "string",
"description": "Value to render when condition is true"
}
},
"required": ["when", "value"],
"additionalProperties": false
},
"Attributes": {
"type": "object",
"description": "HTML attributes for a structural element",
"properties": {
"static": {
"type": "object",
"description": "Hardcoded attribute values",
"properties": {
"class": {
"oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }],
"description": "CSS class(es). Accepts a space-separated string or an array of class names."
}
},
"additionalProperties": { "type": "string" }
},
"bound": {
"type": "object",
"description": "Attributes bound to component props",
"additionalProperties": { "$ref": "#/definitions/BoundAttribute" }
},
"conditional": {
"type": "object",
"description": "Conditionally rendered attributes",
"additionalProperties": {
"oneOf": [
{ "$ref": "#/definitions/ConditionalAttribute" },
{
"type": "array",
"items": { "$ref": "#/definitions/ConditionalAttribute" }
}
]
}
}
},
"additionalProperties": false
},
"BaseChild": {
"type": "object",
"description": "Base child element definition",
"properties": {
"name": {
"type": "string",
"description": "Unique identifier for the child element"
},
"restrict": {
"type": "array",
"items": { "type": "string" },
"description": "Allowed HTML elements"
},
"description": {
"type": "string",
"description": "Description of this child"
},
"attributes": {
"$ref": "#/definitions/Attributes"
},
"renderWhen": {
"oneOf": [
{ "type": "string", "enum": ["slotFilled", "propFilled"] },
{
"type": "object",
"description": "Render when a parent prop equals a specific value",
"properties": {
"prop": { "type": "string", "description": "Prop name to test" },
"eq": { "type": "string", "description": "Value the prop must equal" }
},
"required": ["prop", "eq"],
"additionalProperties": false
}
],
"description": "Conditional rendering — string shorthand or prop-value match"
},
"repeats": {
"type": "boolean",
"description": "Whether this child repeats (maps over array)"
},
"slot": {
"$ref": "#/definitions/Slot"
},
"deprecated": {
"$ref": "#/definitions/Deprecated"
}
},
"required": ["name"],
"additionalProperties": false
},
"AccessibilityRequirement": {
"type": "object",
"description": "Accessibility requirement definition",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the requirement"
},
"description": {
"type": "string",
"description": "Description of the requirement"
}
},
"required": ["id", "description"],
"additionalProperties": false
},
"Accessibility": {
"type": "object",
"description": "Accessibility configuration",
"properties": {
"role": {
"type": "string",
"description": "ARIA role for the component's root element"
},
"requiredProps": {
"type": "array",
"items": { "type": "string" },
"description": "Required ARIA properties"
},
"landmarks": {
"type": "object",
"description": "Landmark region mappings",
"additionalProperties": { "type": "string" }
},
"requirements": {
"type": "array",
"items": { "$ref": "#/definitions/AccessibilityRequirement" },
"description": "List of accessibility requirements"
},
"extensions": { "$ref": "#/definitions/Extensions" }
},
"additionalProperties": false
},
"ComponentRefProp": {
"type": "object",
"description": "Prop definition within a component reference interface",
"properties": {
"type": {
"type": "string",
"enum": ["string", "boolean", "number", "object", "array"],
"description": "Prop data type"
},
"required": {
"type": "boolean",
"description": "Whether the prop is required"
},
"description": {
"type": "string",
"description": "Description of the prop"
},
"default": {
"description": "Default value"
},
"enum": {
"type": "array",
"items": { "type": "string" },
"description": "Allowed values for enum-like props"
}
},
"required": ["type"],
"additionalProperties": false
},
"ComponentRef": {
"type": "object",
"description": "Interface declaration for a composed component",
"properties": {
"description": {
"type": "string",
"description": "Description of how this component is used"
},
"props": {
"type": "object",
"description": "Props available on the composed component",
"additionalProperties": { "$ref": "#/definitions/ComponentRefProp" }
}
},
"required": ["props"],
"additionalProperties": false
},
"Deprecated": {
"type": "object",
"description": "Marks this artifact as deprecated. `message` is required; the remaining fields are optional metadata that consumers use to shape behavior. `since` and `removeBy` are Salesforce / SLDS release numbers (e.g. '262'). The standard deprecation window is three releases (numeric gap of six, since releases increment by two); setting `extensionReason` documents intentional extensions beyond that window. There is no 'removed' state: once `removeBy` ships, the entry is deleted from the UIF.",
"properties": {
"message": {
"type": "string",
"description": "Human-readable explanation of why this is deprecated and what to do."
},
"severity": {
"type": "string",
"enum": ["warning", "error"],
"description": "Optional escalation. Defaults to 'warning'. Use 'error' when migration is urgent (security, accessibility, known breakage) and you want to surface a louder signal."
},
"replacement": {
"type": "object",
"description": "Structured pointer to the replacement. Each field defaults to 'same as the deprecated artifact's context'. At least one of component, prop, or value must be present.",
"properties": {
"component": {
"type": "string",
"description": "Name of the component the replacement lives in. Omit when the replacement is in the same component as the deprecated artifact."
},
"prop": {
"type": "string",
"description": "Name of the prop on that component. Omit when the replacement is on the same prop (e.g., another option of the same modifier)."
},
"value": {
"type": "string",
"description": "Specific value of that prop (option propValue, variant value). Omit for whole-prop or whole-component replacements."
}
},
"additionalProperties": false,
"anyOf": [{ "required": ["component"] }, { "required": ["prop"] }, { "required": ["value"] }]
},
"since": {
"type": "string",
"description": "Salesforce / SLDS release in which the item was deprecated (e.g. '262')."
},
"removeBy": {
"type": "string",
"description": "Planned removal release (e.g. '268'). Convention is `since + 6`."
},
"extensionReason": {
"type": "string",
"description": "One-line justification recorded when removeBy is pushed beyond the standard three-release window. Surfaces in the per-release audit report."
},
"url": {
"type": "string",
"description": "URL to a migration guide, RFC, release notes, or other documentation."
}
},
"required": ["message"],
"additionalProperties": false
},
"Extensions": {
"type": "object",
"description": "Namespaced metadata for third-party tooling. Reverse domain notation is recommended for keys.",
"additionalProperties": {
"type": "object"
}
},
"ComponentProps": {
"type": "object",
"description": "Configuration for how a composed component is wired",
"properties": {
"static": {
"type": "object",
"description": "Hardcoded prop values, always applied",
"additionalProperties": true
},
"bound": {
"type": "object",
"description": "Props bound to parent component props",
"additionalProperties": { "type": "string" }
},
"forwarded": {
"type": "array",
"items": { "type": "string" },
"description": "Props passed through from parent unchanged"
},
"byVariant": {
"type": "object",
"description": "Props determined by parent's variant value",
"additionalProperties": {
"type": "object",
"additionalProperties": true
}
},
"restrict": {
"type": "array",
"items": { "type": "string" },
"description": "Whitelist of allowed props (narrows the child's interface)"
}
},
"additionalProperties": false
}
}
}
|