{
  "id": "@typed/ui/index#VisuallyHidden.VisuallyHidden",
  "canonicalId": "@typed/ui/VisuallyHidden#VisuallyHidden",
  "symbol": {
    "id": "@typed/ui/index#VisuallyHidden.VisuallyHidden",
    "packageName": "@typed/ui",
    "moduleName": "index",
    "exportName": "VisuallyHidden.VisuallyHidden",
    "kind": "function",
    "signatures": [
      "export declare function VisuallyHidden<const Options extends VisuallyHiddenOptions, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.RenderHostProps<Options, VisuallyHiddenInternalProps>, Options[\"content\"], Host>): Fx<RenderEvent, Renderable.Error<Options | Host>, Renderable.Services<Options | Host> | Scope.Scope | RenderTemplate>;"
    ],
    "summary": "Clips text visually while retaining it for accessible naming and reading.",
    "sections": {},
    "examples": [
      {
        "language": "ts",
        "code": "import { RefSubject } from \"@typed/fx\";\nimport { html } from \"@typed/template\";\nimport { Button } from \"@typed/ui/Button\";\nimport { component } from \"@typed/ui/Component\";\nimport { VisuallyHidden } from \"@typed/ui/VisuallyHidden\";\n\nexport const ResetCounter = component(function* () {\n  const count = yield* RefSubject.make(3);\n  return html`<div>\n    <p>Selected items: ${count}</p>\n    ${Button({\n    content: html`\n      <span aria-hidden=\"true\">×</span>\n      ${VisuallyHidden({ content: \"Clear selection\" })}\n    `,\n    props: { class: \"icon-action\" },\n    onclick: RefSubject.set(count, 0),\n    })}\n  </div>`;\n});"
      }
    ],
    "relations": [],
    "source": {
      "file": "packages/ui/src/VisuallyHidden.ts",
      "line": 73
    },
    "since": "1.0.0",
    "category": "Structure and naming"
  },
  "exposure": {
    "recordKind": "declaration",
    "id": "@typed/ui/index#VisuallyHidden.VisuallyHidden",
    "packageName": "@typed/ui",
    "packageVersion": "1.0.0-beta.7",
    "moduleName": "index",
    "consumerSpecifier": "@typed/ui/index",
    "exportName": "VisuallyHidden",
    "qualifiedName": "VisuallyHidden.VisuallyHidden",
    "declarationKey": "declaration:998b6318634c166aa3681d78",
    "family": "function",
    "signatures": [
      "export declare function VisuallyHidden<const Options extends VisuallyHiddenOptions, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.RenderHostProps<Options, VisuallyHiddenInternalProps>, Options[\"content\"], Host>): Fx<RenderEvent, Renderable.Error<Options | Host>, Renderable.Services<Options | Host> | Scope.Scope | RenderTemplate>;"
    ],
    "sourceSpans": [
      {
        "file": "packages/ui/src/VisuallyHidden.ts",
        "start": {
          "line": 73,
          "column": 1
        },
        "end": {
          "line": 95,
          "column": 2
        }
      }
    ],
    "aliases": [
      "@typed/ui#VisuallyHidden.VisuallyHidden",
      "@typed/ui/VisuallyHidden#VisuallyHidden"
    ],
    "isAlias": true,
    "parentId": "@typed/ui/index#VisuallyHidden",
    "static": false,
    "importedFrom": "declaration:998b6318634c166aa3681d78"
  },
  "declaration": {
    "declarationKey": "declaration:998b6318634c166aa3681d78",
    "name": "VisuallyHidden",
    "family": "function",
    "facets": [
      {
        "family": "function",
        "syntaxKind": "FunctionDeclaration",
        "signatures": [
          "export declare function VisuallyHidden<const Options extends VisuallyHiddenOptions, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.RenderHostProps<Options, VisuallyHiddenInternalProps>, Options[\"content\"], Host>): Fx<RenderEvent, Renderable.Error<Options | Host>, Renderable.Services<Options | Host> | Scope.Scope | RenderTemplate>;"
        ],
        "typeParameters": [
          "const Options extends VisuallyHiddenOptions",
          "const Host extends HostResult = never"
        ],
        "sourceSpans": [
          {
            "file": "packages/ui/src/VisuallyHidden.ts",
            "start": {
              "line": 73,
              "column": 1
            },
            "end": {
              "line": 95,
              "column": 2
            }
          }
        ],
        "static": false,
        "readonly": false,
        "optional": false
      }
    ],
    "signatures": [
      "export declare function VisuallyHidden<const Options extends VisuallyHiddenOptions, const Host extends HostResult = never>(options: Options, host?: Dom.HostOverride<Dom.RenderHostProps<Options, VisuallyHiddenInternalProps>, Options[\"content\"], Host>): Fx<RenderEvent, Renderable.Error<Options | Host>, Renderable.Services<Options | Host> | Scope.Scope | RenderTemplate>;"
    ],
    "typeParameters": [
      "const Options extends VisuallyHiddenOptions",
      "const Host extends HostResult = never"
    ],
    "summary": "Clips text visually while retaining it for accessible naming and reading.",
    "sections": {},
    "examples": [
      {
        "language": "ts",
        "code": "import { RefSubject } from \"@typed/fx\";\nimport { html } from \"@typed/template\";\nimport { Button } from \"@typed/ui/Button\";\nimport { component } from \"@typed/ui/Component\";\nimport { VisuallyHidden } from \"@typed/ui/VisuallyHidden\";\n\nexport const ResetCounter = component(function* () {\n  const count = yield* RefSubject.make(3);\n  return html`<div>\n    <p>Selected items: ${count}</p>\n    ${Button({\n    content: html`\n      <span aria-hidden=\"true\">×</span>\n      ${VisuallyHidden({ content: \"Clear selection\" })}\n    `,\n    props: { class: \"icon-action\" },\n    onclick: RefSubject.set(count, 0),\n    })}\n  </div>`;\n});"
      }
    ],
    "sourceSpans": [
      {
        "file": "packages/ui/src/VisuallyHidden.ts",
        "start": {
          "line": 73,
          "column": 1
        },
        "end": {
          "line": 95,
          "column": 2
        }
      }
    ],
    "since": "1.0.0",
    "category": "Structure and naming"
  }
}
