react-test/docs/translations/api-docs-base/slider/slider.json

{
  "componentDescription": "",
  "propDescriptions": {
    "aria-label": { "description": "The label of the slider." },
    "aria-labelledby": {
      "description": "The id of the element containing a label for the slider."
    },
    "aria-valuetext": {
      "description": "A string value that provides a user-friendly name for the current value of the slider."
    },
    "defaultValue": {
      "description": "The default value. Use when the component is not controlled."
    },
    "disabled": { "description": "If <code>true</code>, the component is disabled." },
    "disableSwap": {
      "description": "If <code>true</code>, the active thumb doesn&#39;t swap when moving pointer over a thumb while dragging another thumb."
    },
    "getAriaLabel": {
      "description": "Accepts a function which returns a string value that provides a user-friendly name for the thumb labels of the slider. This is important for screen reader users.",
      "typeDescriptions": { "index": "The thumb label&#39;s index to format." }
    },
    "getAriaValueText": {
      "description": "Accepts a function which returns a string value that provides a user-friendly name for the current value of the slider. This is important for screen reader users.",
      "typeDescriptions": {
        "value": "The thumb label&#39;s value to format.",
        "index": "The thumb label&#39;s index to format."
      }
    },
    "isRtl": {
      "description": "If <code>true</code> the Slider will be rendered right-to-left (with the lowest value on the right-hand side)."
    },
    "marks": {
      "description": "Marks indicate predetermined values to which the user can move the slider. If <code>true</code> the marks are spaced according the value of the <code>step</code> prop. If an array, it should contain objects with <code>value</code> and an optional <code>label</code> keys."
    },
    "max": {
      "description": "The maximum allowed value of the slider. Should not be equal to min."
    },
    "min": {
      "description": "The minimum allowed value of the slider. Should not be equal to max."
    },
    "name": { "description": "Name attribute of the hidden <code>input</code> element." },
    "onChange": {
      "description": "Callback function that is fired when the slider&#39;s value changed.",
      "typeDescriptions": {
        "event": "The event source of the callback. You can pull out the new value by accessing <code>event.target.value</code> (any). <strong>Warning</strong>: This is a generic event not a change event.",
        "value": "The new value.",
        "activeThumb": "Index of the currently moved thumb."
      }
    },
    "onChangeCommitted": {
      "description": "Callback function that is fired when the <code>mouseup</code> is triggered.",
      "typeDescriptions": {
        "event": "The event source of the callback. <strong>Warning</strong>: This is a generic event not a change event.",
        "value": "The new value."
      }
    },
    "orientation": { "description": "The component orientation." },
    "scale": { "description": "A transformation function, to change the scale of the slider." },
    "shiftStep": {
      "description": "The granularity with which the slider can step through values when using Page Up/Page Down or Shift + Arrow Up/Arrow Down."
    },
    "slotProps": { "description": "The props used for each slot inside the Slider." },
    "slots": {
      "description": "The components used for each slot inside the Slider. Either a string to use a HTML element or a component."
    },
    "step": {
      "description": "The granularity with which the slider can step through values. (A &quot;discrete&quot; slider.) The <code>min</code> prop serves as the origin for the valid values. We recommend (max - min) to be evenly divisible by the step.<br>When step is <code>null</code>, the thumb can only be slid onto marks provided with the <code>marks</code> prop."
    },
    "tabIndex": { "description": "Tab index attribute of the hidden <code>input</code> element." },
    "track": {
      "description": "<p>The track presentation:</p>\n<ul>\n<li><code>normal</code> the track will render a bar representing the slider value.</li>\n<li><code>inverted</code> the track will render a bar representing the remaining slider value.</li>\n<li><code>false</code> the track will render without a bar.</li>\n</ul>\n"
    },
    "value": {
      "description": "The value of the slider. For ranged sliders, provide an array with two values."
    },
    "valueLabelFormat": {
      "description": "The format function the value label&#39;s value.<br>When a function is provided, it should have the following signature:<br>- {number} value The value label&#39;s value to format - {number} index The value label&#39;s index to format"
    }
  },
  "classDescriptions": {
    "active": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the thumb element",
      "conditions": "it&#39;s active"
    },
    "disabled": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root and thumb element",
      "conditions": "<code>disabled={true}</code>"
    },
    "dragging": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root",
      "conditions": "a thumb is being dragged"
    },
    "focusVisible": {
      "description": "State class applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the thumb element",
      "conditions": "keyboard focused"
    },
    "markActive": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the mark element",
      "conditions": "active (depending on the value)"
    },
    "marked": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>marks</code> is provided with at least one label"
    },
    "markLabelActive": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the mark label element",
      "conditions": "active (depending on the value)"
    },
    "trackFalse": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>track={false}</code>"
    },
    "trackInverted": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>track=\"inverted\"</code>"
    },
    "vertical": {
      "description": "Class name applied to {{nodeName}} if {{conditions}}.",
      "nodeName": "the root element",
      "conditions": "<code>orientation=\"vertical\"</code>"
    }
  },
  "slotDescriptions": {
    "input": "The component that renders the input.",
    "mark": "The component that renders the mark.",
    "markLabel": "The component that renders the mark label.",
    "rail": "The component that renders the rail.",
    "root": "The component that renders the root.",
    "thumb": "The component that renders the thumb.",
    "track": "The component that renders the track.",
    "valueLabel": "The component that renders the value label."
  }
}