Developer ReferenceConfiguration File

Wrapper Parser Configuration

On this page

Description:

This key defines a wrapper parser configuration for wrapping another snippet configuration.

The value is an object that contains a parser property set to wrapper and an options object with snippet and optional remove_empty properties. The wrapper parser wraps another snippet configuration, allowing it to be used within a different snippet context.

Appears in:
└── Snippet
    └── params
        └── *
            └── Wrapper Parser Configuration
Type:
Object
Properties:
optionsObject Required#

This key defines configuration options for wrapper parser configurations.

The value is an object that can contain snippet and remove_empty properties. These options control which snippet configuration is wrapped and whether empty values are removed.

Appears in: Wrapper Parser Configuration.

Show examplesHide examples

In this example, we have configured wrapper parser options with a snippet reference.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[wrapped_content]]>>
    params:
      wrapped_content:
        parser: wrapper
        options:
          snippet: content
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[wrapped_content]]>>",
      "params": {
        "wrapped_content": {
          "parser": "wrapper",
          "options": {
            "snippet": "content"
          }
        }
      }
    }
  }
}
parser"wrapper" Required#

This key defines the parser type for wrapper parser configurations.

The value must be wrapper. This specifies that the parameter uses the wrapper parser, which wraps another snippet configuration.

Appears in: Wrapper Parser Configuration.

Show examplesHide examples

In this example, we have configured a wrapper parser for a snippet parameter.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[wrapped_content]]>>
    params:
      wrapped_content:
        parser: wrapper
        options:
          snippet: content
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[wrapped_content]]>>",
      "params": {
        "wrapped_content": {
          "parser": "wrapper",
          "options": {
            "snippet": "content"
          }
        }
      }
    }
  }
}
Examples:

In this example, we have configured a wrapper parser to wrap a content snippet.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[wrapped_content]]>>
    params:
      wrapped_content:
        parser: wrapper
        options:
          snippet: content
  content:
    snippet: <<content [[text]]>>
    params:
      text:
        parser: content
        options:
          editor_key: content_text
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[wrapped_content]]>>",
      "params": {
        "wrapped_content": {
          "parser": "wrapper",
          "options": {
            "snippet": "content"
          }
        }
      }
    },
    "content": {
      "snippet": "<<content [[text]]>>",
      "params": {
        "text": {
          "parser": "content",
          "options": {
            "editor_key": "content_text"
          }
        }
      }
    }
  }
}
Open in a new tab