Customizing the Settings panel (Guide Professional and Enterprise)

Return to top

9 Comments

  • Mark Pickard

    Is there going to support for multiline text areas in the manifest.json settings? Currently my code is:

    {

    "identifier": "top_tips_1_heading",

    "type": "text",

    "description": "Heading",

    "label": "Top Tip 1 Heading",

    "value": "How do I link my bank account to the app?"

    },

    {

    "identifier": "top_tips_1_body",

    "type": "multiline",

    "description": "Answer",

    "label": "Top Tip 1 Answer",

    "value": "Test"

    },

    I saw some articles mention "type" "multiline" so when the theme is imported the editor can enter multi line values instead of putting a sentence all in one line of a text field.

    However "multiline" does not seem to be supported I get the following error on import:

    If it doesn't match any of the required schemas how can I get it to match? We really need a multi line text area in the settings so our editors can add multi line answers to the settings of our theme. Can you tell me how to achieve this please? See the below screen as an example of us typing in a single field...

    0
  • Augusto Silva
    Zendesk Engineering

    Hey @...,

    The screenshot of types you posted are for apps. Themes don't support multi-line right now. In this article, you can find which types of settings are available for themes.

    Specifically for your use case, we recommend using dynamic content instead, as this supports translating to multiple languages as well. :)

    0
  • Michael Eugster

    In this help article I found the option to add a text variable to the help center. How can I use it in my html templates? https://support.zendesk.com/hc/en-us/articles/115012547687-Customizing-the-Settings-panel-Guide-Professional-and-Enterprise-#variable-object

    0
  • Jupete Manitas

    Hi Michael,

    Thanks for writing! You may want to look into this article Using variables in CSS and HTML. It will provide you guidance on how you can use variables in CSS and variables in Curlybars in HTML. Thank you!

    0
  • Michael Eugster

    Thank you, @.... I already know this guide, but I was looking for an option where I can define a text variable in the settings and then using this variable in my template.

    I resolved it by using dynamic content – like this it's also translateable. But maybe there's an even better solution?

    0
  • Jupete Manitas

    Hi Michael,

    I'm afraid, there is no other way. Our documentation suggested using the exporting the theme or using style.css file and using curlybars expressions in HTML. Thank you!

    1
  • Augusto Silva
    Zendesk Engineering

    Hi @...,

    If you add a setting to manifest.json by exporting the theme and making this change locally, you can then access it via {{settings.setting_identifier}}

    We have some more info in https://developer.zendesk.com/documentation/help_center/help-center-templates/objects/#settings-object

     

    1
  • Michael Eugster

    @... Thanks for your answer – the variable was the missing piece in my case. Even though I'm not quite sure if this is the best solution (because there's not way to translate it), this should probably work (not tested yet).

    0
  • Nathan Purcell

    The ever-unhelpful "The property '#/settings/X/variables/X' of type object did not match any of the required schemas" message could still do with an update. 

    Even a note in this article or similar reminding users that the indexes start at 0 so they can narrow down the cause of the problem. 

    And giving proper detail on the requirements of fields in the JSON file. 

    For example, I ran into the error above because I had an empty string in the description of a variable. 

    0

Please sign in to leave a comment.

Powered by Zendesk