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 | 10x 10x 10x 10x 10x 10x 10x 10x 10x 10x | {
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://slds.lightningdesignsystem.com/schemas/uif-system.v1.json",
"title": "UIF System Schema",
"description": "Schema for design-system specific component definitions",
"type": "object",
"properties": {
"$schema": {
"type": "string",
"description": "JSON Schema URI for validation"
},
"apiVersion": {
"type": "string",
"pattern": "^\\d+\\.\\d+\\.\\d+$",
"description": "UIF schema version (e.g., '1.0.0')"
},
"extends": {
"type": "string",
"description": "Path to base foundation UIF file (if extending)"
},
"name": {
"type": "string",
"pattern": "^[A-Z][a-zA-Z0-9]*$",
"description": "Component name in PascalCase (required for standalone)"
},
"description": {
"type": "string",
"description": "Brief description of the component (required for standalone)"
},
"styleApi": {
"$ref": "#/definitions/StyleApi",
"description": "Status of the component's styling API"
},
"stateClasses": {
"type": "array",
"items": { "$ref": "#/definitions/StateClass" },
"description": "CSS class mappings for foundation states"
},
"structure": {
"$ref": "#/definitions/SystemStructure",
"description": "Root structural node (required for standalone)"
},
"cssSource": {
"type": "string",
"description": "Relative path to the component's CSS file (theme layer format)"
}
},
"required": ["apiVersion"],
"additionalProperties": false,
"if": {
"not": { "required": ["extends"] }
},
"then": {
"required": ["apiVersion", "name", "description", "structure"]
},
"definitions": {
"StyleApi": {
"type": "object",
"description": "Styling API status",
"properties": {
"status": {
"type": "string",
"enum": ["stable", "in-development", "deprecated"],
"description": "Current status of the styling API"
},
"ready": {
"type": "boolean",
"description": "Whether the styling API is ready for use"
}
},
"additionalProperties": false
},
"StateClass": {
"type": "object",
"description": "CSS class mapping for a foundation-defined state",
"properties": {
"state": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/IdentifierName",
"description": "Name of the state from the foundation (must be a valid identifier)"
},
"class": {
"type": "string",
"description": "CSS class to apply when state is active"
}
},
"required": ["state", "class"],
"additionalProperties": false
},
"Modifier": {
"type": "object",
"description": "CSS interface modifier - either boolean (with value) or grouped (with options)",
"properties": {
"name": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/IdentifierName",
"description": "Unique identifier for the modifier (becomes a prop). Must be a valid identifier."
},
"attribute": {
"type": "string",
"description": "The HTML attribute to target (e.g., 'class', 'data-variant')"
},
"value": {
"type": "string",
"description": "Value to add when modifier is active (for boolean modifiers)"
},
"options": {
"type": "array",
"items": { "$ref": "#/definitions/ModifierOption" },
"description": "Available options for grouped modifiers"
},
"default": {
"type": "string",
"description": "Default option value for grouped modifiers"
},
"description": {
"type": "string",
"description": "Description of the modifier's effect"
}
},
"required": ["name", "attribute"],
"oneOf": [
{
"required": ["value"],
"not": { "required": ["options"] }
},
{
"required": ["options"],
"not": { "required": ["value"] }
}
],
"additionalProperties": false
},
"ModifierOption": {
"type": "object",
"description": "Option within a grouped modifier",
"properties": {
"propValue": {
"type": "string",
"description": "The consumer-facing option value (used as prop value)"
},
"value": {
"type": "string",
"description": "The attribute value to apply (e.g., CSS class)"
}
},
"required": ["propValue", "value"],
"additionalProperties": false
},
"VariantOption": {
"type": "object",
"description": "Option within a variant",
"properties": {
"value": {
"type": "string",
"description": "The option value (used as prop value)"
},
"class": {
"type": "string",
"description": "CSS class to apply for this variant"
},
"description": {
"type": "string",
"description": "Description of this variant option"
},
"restrict": {
"type": "array",
"items": { "type": "string" },
"description": "Override element restriction for this variant"
},
"children": {
"type": "array",
"items": { "$ref": "#/definitions/SystemChild" },
"description": "Override or extend children for this variant"
},
"slots": {
"type": "object",
"additionalProperties": { "type": "boolean" },
"description": "Enable/disable slots (false hides, true shows)"
}
},
"required": ["value"],
"additionalProperties": false
},
"Variant": {
"type": "object",
"description": "Structural variant definition",
"properties": {
"name": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/IdentifierName",
"description": "Unique identifier for the variant (becomes a prop). Must be a valid identifier."
},
"description": {
"type": "string",
"description": "Description of the variant"
},
"options": {
"type": "array",
"items": { "$ref": "#/definitions/VariantOption" },
"description": "The available options for this variant"
},
"default": {
"type": "string",
"description": "Default option value (first option if not specified)"
}
},
"required": ["name", "options"],
"additionalProperties": false
},
"SystemChild": {
"type": "object",
"description": "Child element in system structure",
"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"
},
"component": {
"type": "string",
"description": "Reference to another UIF component (instead of HTML element)"
},
"componentProps": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/ComponentProps",
"description": "Configuration for how the composed component is wired"
},
"attributes": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/Attributes"
},
"renderWhen": {
"type": "string",
"enum": ["slotFilled"],
"description": "Conditional rendering"
},
"repeats": {
"type": "boolean",
"description": "Whether this child repeats (maps over array)"
},
"slot": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/Slot"
},
"children": {
"type": "array",
"items": { "$ref": "#/definitions/SystemChild" },
"description": "Nested children"
},
"modifiers": {
"type": "array",
"items": { "$ref": "#/definitions/Modifier" },
"description": "CSS interface modifiers"
},
"variants": {
"type": "array",
"items": { "$ref": "#/definitions/Variant" },
"description": "Structural variants"
}
},
"required": ["name"],
"additionalProperties": false
},
"SystemStructure": {
"type": "object",
"description": "Root structural node for systems",
"properties": {
"name": {
"type": "string",
"description": "Unique identifier for this structural node"
},
"restrict": {
"type": "array",
"items": { "type": "string" },
"description": "Allowed HTML elements (first is used for generation)"
},
"description": {
"type": "string",
"description": "Description of this structural element"
},
"attributes": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/Attributes"
},
"children": {
"type": "array",
"items": { "$ref": "#/definitions/SystemChild" },
"description": "Child elements and slots"
},
"slot": {
"$ref": "https://slds.lightningdesignsystem.com/schemas/uif-shared.v1.json#/definitions/Slot"
},
"modifiers": {
"type": "array",
"items": { "$ref": "#/definitions/Modifier" },
"description": "CSS interface modifiers"
},
"variants": {
"type": "array",
"items": { "$ref": "#/definitions/Variant" },
"description": "Structural variants"
}
},
"additionalProperties": false
}
}
}
|