Skip to content

elements-options.md

Latest commit

 

History

History
22 lines (20 loc) · 2.04 KB

elements-options.md

File metadata and controls

22 lines (20 loc) · 2.04 KB

Elements Configuration Options

  • apiDescriptionUrl - OpenAPI document URL, supporting http://, https://, and documents containing $ref to other http(s) documents.
  • apiDescriptionDocument - OpenAPI document, provided as YAML string, JSON string, or JavaScript object.
  • basePath - Helps when using router: 'history' but docs are in a subdirectory like https://example.com/docs/api.
  • hideInternal - Pass "true" to filter out any content which has been marked as internal with x-internal.
  • hideTryIt - Pass true to hide the Try It feature.
  • hideSchemas - Pass true to hide the schemas in the Table of Contents, when using the sidebar layout.
  • hideExport - Pass true to hide the Export button on overview section of the documentation.
  • tryItCorsProxy - Pass the URL of a CORS proxy used to send requests to the Try It feature. The provided URL is pre-pended to the URL of an actual request.
  • tryItCredentialsPolicy - Use to fetch the credential policy for the Try It feature. Options are: omit (default), include, and same-origin.
  • layout - There are three layouts for Elements:
    • sidebar - (default) Three-column design with a sidebar that can be resized.
    • responsive - Like sidebar, except at small screen sizes it collapses the sidebar into a drawer that can be toggled open.
    • stacked - Everything in a single column, making integrations with existing websites that have their own sidebar or other columns already.
  • logo - URL to an image that displays as a small square logo next to the title, above the table of contents.
  • router - Determines how navigation should work:
    • history - (default) uses the HTML5 history API to keep the UI in sync with the URL.
    • hash - uses the hash portion of the URL to keep the UI in sync with the URL.
    • memory - keeps the history of your "URL" in memory (doesn't read or write to the address bar).
    • static - renders using the StaticRouter which can help render pages on the server.