{
  "_copyright": "Copyright (c) 2026, Salesforce, Inc., All rights reserved. For full license text, see the LICENSE.txt file",
  "$schema": "https://slds.lightningdesignsystem.com/schemas/uif-system.v1.json",
  "apiVersion": "1.0.0",
  "name": "SetupAssistant",
  "description": "Ordered list of setup steps that guide a user through configuring an org, where each step shows a progress ring or step number, a title, supporting copy, an optional action, and may expand to reveal a nested progress checklist.",
  "extensions": {
    "com.salesforce-ux": {
      "genReady": false
    }
  },
  "cssSource": "./setupAssistant.css",
  "styleApi": {
    "status": "stable",
    "ready": true
  },
  "structure": {
    "name": "setupAssistant",
    "restrict": [
      "ol"
    ],
    "description": "Root ordered list that contains the setup steps.",
    "attributes": {
      "static": {
        "class": "slds-setup-assistant"
      }
    },
    "children": [
      {
        "name": "item",
        "restrict": [
          "li"
        ],
        "description": "List item that wraps a single setup step and provides the divider between steps.",
        "repeats": true,
        "attributes": {
          "static": {
            "class": "slds-setup-assistant__item"
          }
        },
        "children": [
          {
            "name": "step",
            "restrict": [
              "article"
            ],
            "description": "Single setup step. Hosts either a step summary directly, or a summary-detail wrapper when the step is expandable.",
            "attributes": {
              "static": {
                "class": "slds-setup-assistant__step"
              }
            },
            "children": [
              {
                "name": "summaryDetail",
                "restrict": [
                  "div"
                ],
                "description": "Expandable wrapper that toggles the visibility of the step detail. Only rendered when the step is expandable.",
                "renderWhen": {
                  "prop": "expandable",
                  "eq": "true"
                },
                "attributes": {
                  "static": {
                    "class": "slds-summary-detail"
                  }
                },
                "children": [
                  {
                    "name": "toggleButton",
                    "restrict": [
                      "button"
                    ],
                    "description": "Icon button that toggles the visibility of the step detail.",
                    "attributes": {
                      "static": {
                        "class": "slds-button slds-button_icon slds-m-right_x-small slds-m-top_x-small"
                      }
                    },
                    "children": [
                      {
                        "name": "toggleIcon",
                        "description": "Chevron/switch glyph rendered inside the toggle button.",
                        "attributes": {
                          "static": {
                            "class": "slds-button__icon slds-summary-detail__action-icon"
                          }
                        },
                        "component": "PrimitiveIcon"
                      },
                      {
                        "name": "toggleAssistiveText",
                        "restrict": [
                          "span"
                        ],
                        "description": "Visually hidden label announcing the toggle action for the step.",
                        "attributes": {
                          "static": {
                            "class": "slds-assistive-text"
                          }
                        }
                      }
                    ]
                  },
                  {
                    "name": "summaryDetailInner",
                    "restrict": [
                      "div"
                    ],
                    "description": "Inner wrapper grouping the summary title and content regions inside the summary-detail.",
                    "children": [
                      {
                        "name": "summaryDetailTitle",
                        "restrict": [
                          "div"
                        ],
                        "description": "Title region of the summary-detail; hosts the step summary.",
                        "attributes": {
                          "static": {
                            "class": "slds-summary-detail__title"
                          }
                        }
                      },
                      {
                        "name": "summaryDetailContent",
                        "restrict": [
                          "div"
                        ],
                        "description": "Collapsible content region of the summary-detail; hosts the step detail. Toggled by the hidden attribute.",
                        "attributes": {
                          "static": {
                            "class": "slds-summary-detail__content"
                          }
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "name": "stepSummary",
                "restrict": [
                  "div"
                ],
                "description": "Step summary region containing the progress ring/step number, title, supporting copy, and primary action.",
                "attributes": {
                  "static": {
                    "class": "slds-setup-assistant__step-summary"
                  }
                },
                "children": [
                  {
                    "name": "stepSummaryMedia",
                    "restrict": [
                      "div"
                    ],
                    "description": "Media object that lays out the optional progress ring/step number alongside the step body.",
                    "attributes": {
                      "static": {
                        "class": "slds-media"
                      }
                    },
                    "children": [
                      {
                        "name": "stepSummaryFigure",
                        "restrict": [
                          "div"
                        ],
                        "description": "Media figure that holds the progress ring or step-number indicator at the inline-start of the step.",
                        "attributes": {
                          "static": {
                            "class": "slds-media__figure"
                          }
                        }
                      },
                      {
                        "name": "stepSummaryBody",
                        "restrict": [
                          "div"
                        ],
                        "description": "Media body that hosts the inner media object grouping the step content and action.",
                        "renderWhen": {
                          "prop": "hasFigure",
                          "eq": "true"
                        },
                        "attributes": {
                          "static": {
                            "class": "slds-media__body slds-m-top_x-small"
                          }
                        },
                        "children": [
                          {
                            "name": "stepSummaryInnerMedia",
                            "restrict": [
                              "div"
                            ],
                            "description": "Inner media object that lays out the step content (title + description) alongside the action region.",
                            "attributes": {
                              "static": {
                                "class": "slds-media"
                              }
                            },
                            "children": [
                              {
                                "name": "stepSummaryContent",
                                "restrict": [
                                  "div"
                                ],
                                "description": "Container for the step title and supporting description text.",
                                "attributes": {
                                  "static": {
                                    "class": "slds-setup-assistant__step-summary-content slds-media__body"
                                  }
                                },
                                "children": [
                                  {
                                    "name": "stepSummaryTitle",
                                    "restrict": [
                                      "h3"
                                    ],
                                    "description": "Step title. May contain a reset-styled button when the step is expandable.",
                                    "attributes": {
                                      "static": {
                                        "class": "slds-setup-assistant__step-summary-title slds-text-heading_small"
                                      }
                                    },
                                    "children": [
                                      {
                                        "name": "stepSummaryTitleToggle",
                                        "restrict": [
                                          "button"
                                        ],
                                        "description": "Reset-styled button that lets the user activate the title to toggle the expandable step.",
                                        "renderWhen": {
                                          "prop": "expandable",
                                          "eq": "true"
                                        },
                                        "attributes": {
                                          "static": {
                                            "class": "slds-button slds-button_reset"
                                          }
                                        }
                                      }
                                    ]
                                  },
                                  {
                                    "name": "stepSummaryDescription",
                                    "restrict": [
                                      "p"
                                    ],
                                    "description": "Supporting copy describing what the step accomplishes."
                                  }
                                ]
                              },
                              {
                                "name": "stepSummaryActions",
                                "restrict": [
                                  "div"
                                ],
                                "description": "Reverse-aligned media figure that hosts the step's primary action (button, link, or toggle) and optional time-to-complete copy.",
                                "attributes": {
                                  "static": {
                                    "class": "slds-media__figure slds-media__figure_reverse"
                                  }
                                }
                              }
                            ]
                          }
                        ]
                      },
                      {
                        "name": "stepSummaryContentDirect",
                        "restrict": [
                          "div"
                        ],
                        "description": "Container for the step title and supporting copy when the step is rendered without a progress-ring or step-number figure.",
                        "renderWhen": {
                          "prop": "hasFigure",
                          "eq": "false"
                        },
                        "attributes": {
                          "static": {
                            "class": "slds-setup-assistant__step-summary-content slds-media__body"
                          }
                        },
                        "children": [
                          {
                            "name": "stepSummaryTitleDirect",
                            "restrict": [
                              "h3"
                            ],
                            "description": "Step title rendered directly inside the media body.",
                            "attributes": {
                              "static": {
                                "class": "slds-setup-assistant__step-summary-title slds-text-heading_small"
                              }
                            }
                          },
                          {
                            "name": "stepSummaryDescriptionDirect",
                            "restrict": [
                              "p"
                            ],
                            "description": "Supporting copy describing what the step accomplishes."
                          }
                        ]
                      },
                      {
                        "name": "stepSummaryActionsDirect",
                        "restrict": [
                          "div"
                        ],
                        "description": "Reverse-aligned media figure (outer-level) that hosts the step's primary action when there is no progress-ring/step-number figure.",
                        "renderWhen": {
                          "prop": "hasFigure",
                          "eq": "false"
                        },
                        "attributes": {
                          "static": {
                            "class": "slds-media__figure slds-media__figure_reverse"
                          }
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "name": "stepDetail",
                "restrict": [
                  "div"
                ],
                "description": "Detail region revealed when an expandable step is open. Typically hosts a nested vertical progress checklist and optional scoped notifications.",
                "renderWhen": {
                  "prop": "expandable",
                  "eq": "true"
                },
                "attributes": {
                  "static": {
                    "class": "slds-setup-assistant__step-detail"
                  }
                }
              }
            ]
          }
        ]
      }
    ]
  },
  "stateClasses": [
    {
      "state": "open",
      "class": "slds-is-open"
    }
  ],
  "componentRefs": {
    "PrimitiveIcon": {
      "description": "Bare SVG icon composed directly inside the component. The host node supplies the SVG class (e.g. slds-button__icon, slds-menu__item-icon) via componentProps; PrimitiveIcon contributes the sprite-href binding.",
      "props": {
        "iconName": {
          "type": "string",
          "required": true,
          "description": "Sprite reference for the icon glyph"
        }
      }
    }
  },
  "states": [
    {
      "name": "open",
      "type": "boolean",
      "description": "Whether the component is in the open state"
    }
  ]
}