components.json

{
  "library": "above-the-fold-only-server-render",
  "description": "A React component wrapper for optionally skipping SSR.",
  "components": [
    {
      "methods": [
        {
          "name": "_onShow",
          "docblock": null,
          "modifiers": [],
          "params": [],
          "returns": {
            "type": {
              "name": "void"
            }
          }
        }
      ],
      "props": {
        "contextKey": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "Tell AboveTheFoldOnlyServerRender to read context in order to skip server side rendering"
        },
        "placeholder": {
          "type": {
            "name": "element"
          },
          "required": false,
          "description": "Pass in another element to render when skipping server side rendering"
        },
        "placeholderClassName": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "Sets the className of the default placeholder"
        },
        "placeholderStyle": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "Sets the style of the default placeholder"
        },
        "skip": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "description": "Tell AboveTheFoldOnlyServerRender to skip server side rendering"
        }
      },
      "fileName": "./src/components/above-the-fold-only-server-render.jsx",
      "description": "A component for configurable skip loading.",
      "examples": "```jsx\n<AboveTheFoldOnlyServerRender skip={true}>\n  <Footer />\n</AboveTheFoldOnlyServerRender>\n```",
      "component": "AboveTheFoldOnlyServerRender",
      "import": "{AboveTheFoldOnlyServerRender}",
      "playground": [
        {
          "title": "AboveTheFoldOnlyServerRender",
          "flags": {},
          "code": "<AboveTheFoldOnlyServerRender skip={true}>\n  <Footer />\n</AboveTheFoldOnlyServerRender>\n"
        }
      ],
      "returns": "The rendered component",
      "hasProps": true
    }
  ]
}