@spark-ui/progress-tracker/dist/public/docgen.json

A progress tracker component is a visual navigation element typically used to display progress or guide user through a multi-step process.

{
  "ProgressTracker": {
    "tags": {},
    "description": "",
    "displayName": "ProgressTracker",
    "methods": [],
    "props": {
      "orientation": {
        "defaultValue": {
          "value": "'horizontal\""
        },
        "description": "The orientation of the progress tracker",
        "name": "orientation",
        "parent": {
          "fileName": "progress-tracker/src/ProgressTracker.tsx",
          "name": "ProgressTrackerProps"
        },
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTracker.tsx",
            "name": "ProgressTrackerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "enum",
          "raw": "\"horizontal\" | \"vertical\"",
          "value": [
            {
              "value": "\"horizontal\""
            },
            {
              "value": "\"vertical\""
            }
          ]
        }
      },
      "stepIndex": {
        "defaultValue": {
          "value": "0"
        },
        "description": "The index of the current step.",
        "name": "stepIndex",
        "parent": {
          "fileName": "progress-tracker/src/ProgressTracker.tsx",
          "name": "ProgressTrackerProps"
        },
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTracker.tsx",
            "name": "ProgressTrackerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "number"
        }
      },
      "onStepClick": {
        "defaultValue": null,
        "description": "Event handler called when clicking on a step.",
        "name": "onStepClick",
        "parent": {
          "fileName": "progress-tracker/src/ProgressTracker.tsx",
          "name": "ProgressTrackerProps"
        },
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTracker.tsx",
            "name": "ProgressTrackerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "(stepIndex: number) => void"
        }
      },
      "readOnly": {
        "defaultValue": {
          "value": "false"
        },
        "description": "Sets the component as interactive or not.",
        "name": "readOnly",
        "parent": {
          "fileName": "progress-tracker/src/ProgressTracker.tsx",
          "name": "ProgressTrackerProps"
        },
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTracker.tsx",
            "name": "ProgressTrackerProps"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      },
      "size": {
        "defaultValue": null,
        "description": "",
        "name": "size",
        "declarations": [],
        "required": false,
        "type": {
          "name": "enum",
          "raw": "\"sm\" | \"md\" | \"lg\"",
          "value": [
            {
              "value": "\"sm\""
            },
            {
              "value": "\"md\""
            },
            {
              "value": "\"lg\""
            }
          ]
        }
      },
      "intent": {
        "defaultValue": null,
        "description": "",
        "name": "intent",
        "declarations": [],
        "required": false,
        "type": {
          "name": "enum",
          "raw": "\"main\" | \"basic\" | \"support\" | \"neutral\" | \"info\" | \"accent\" | \"danger\" | \"alert\" | \"success\"",
          "value": [
            {
              "value": "\"main\""
            },
            {
              "value": "\"basic\""
            },
            {
              "value": "\"support\""
            },
            {
              "value": "\"neutral\""
            },
            {
              "value": "\"info\""
            },
            {
              "value": "\"accent\""
            },
            {
              "value": "\"danger\""
            },
            {
              "value": "\"alert\""
            },
            {
              "value": "\"success\""
            }
          ]
        }
      },
      "design": {
        "defaultValue": null,
        "description": "",
        "name": "design",
        "declarations": [],
        "required": false,
        "type": {
          "name": "enum",
          "raw": "\"outline\" | \"tinted\"",
          "value": [
            {
              "value": "\"outline\""
            },
            {
              "value": "\"tinted\""
            }
          ]
        }
      }
    }
  },
  "ProgressTrackerContext": {
    "tags": {},
    "description": "",
    "displayName": "ProgressTrackerContext",
    "methods": [],
    "props": {}
  },
  "ProgressTrackerStepContext": {
    "tags": {},
    "description": "",
    "displayName": "ProgressTrackerStepContext",
    "methods": [],
    "props": {}
  },
  "ProgressTracker.Step": {
    "tags": {},
    "description": "",
    "displayName": "ProgressTracker.Step",
    "methods": [],
    "props": {
      "disabled": {
        "defaultValue": {
          "value": false
        },
        "description": "",
        "name": "disabled",
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTrackerStep.tsx",
            "name": "TypeLiteral"
          },
          {
            "fileName": "progress-tracker/src/ProgressTrackerStep.tsx",
            "name": "TypeLiteral"
          }
        ],
        "required": false,
        "type": {
          "name": "boolean"
        }
      }
    }
  },
  "ProgressTracker.StepIndicator": {
    "tags": {},
    "description": "",
    "displayName": "ProgressTracker.StepIndicator",
    "methods": [],
    "props": {
      "complete": {
        "defaultValue": null,
        "description": "The content to be rendered when step status is complete (checkmark icon by default)",
        "name": "complete",
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTrackerStepIndicator.tsx",
            "name": "TypeLiteral"
          }
        ],
        "required": false,
        "type": {
          "name": "ReactNode"
        }
      },
      "incomplete": {
        "defaultValue": null,
        "description": "The content to be rendered when step status is incomplete (step index by default)",
        "name": "incomplete",
        "declarations": [
          {
            "fileName": "progress-tracker/src/ProgressTrackerStepIndicator.tsx",
            "name": "TypeLiteral"
          }
        ],
        "required": false,
        "type": {
          "name": "ReactNode"
        }
      }
    }
  },
  "ProgressTracker.StepLabel": {
    "tags": {},
    "description": "",
    "displayName": "ProgressTracker.StepLabel",
    "methods": [],
    "props": {}
  }
}