Customizing the Settings panel of the theme

Return to top

15 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...

    1
  • 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
  • ZURIGA AG

    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
    Zendesk Customer Care

    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
  • ZURIGA AG

    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
    Zendesk Customer Care

    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
  • ZURIGA AG

    @... 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. 

    1
  • Jon Bolden

    I just wanted to post something I just realized about the vague error messages

    This error:

    The property '#/settings/X/variables/X' of type object did not match any of the required schemas

    Actually does clue us into where the error is

    settings/X refers to which "group" contains the error, starting from zero as one.  And the variable number is the number corresponding to that variable, also starting with zero as one.
    So :

    #/settings/2/variables/7'

     

    Means there is a problem with the third group and the 8th variable. It could be a wrong type of variable, a bad value, missing property, or too many characters (or invalid characters).

    So in this context, it's a problem in the "brand" group, because brand is the third setting. Then count from zero to 8 to find the variable in question.

    0
  • Hamish Lang

    Can we look to please add more information to this article around the limits for the following things: 

    - Total amount of values in an option array (article states minimum 1 but I'm unsure on maximum)

    - Character limits for labels and descriptions

    - Character limits within text fields (I think this is 999)

    - Max quantity of variable objects (I realise this is 200 but would be helpful to have all of this information centralised). 

    Many thanks

    0
  • Nathan Purcell

    To echo Hamish, can more details be added on the limitations in the manifest file? 

    Receiving an unhelpful message that reads "The property '#/settings/0/variables/X' of type object did not match any of the required schemas" doesn't give us much to go on. 

    The limit will be known to you, so adding docs should take a couple of minutes, not months. 

     

    Edit to add, the length of descriptions, labels etc. is not flagged by ZAT, so I hope you can understand the frustration that a limit is only being imposed at the last step. 

    2
  • Sabra
    Zendesk Customer Care

    Hey Hamish Lang and Nathan Purcell! Thanks for calling out that the limitations aren't documented as well as they should be in this article. Our Guide team is currently working on updating this article to have more information. In the meantime, I can provide you with this information:

    • Total amount of values in an option array: currently, there is no limit. 
    • Character limits for labels and descriptions: currently, there is no limit.
    • Character limits within text fields: 1000 characters.
    • Max quantity of variable objects: 200 objects. 
    0
  • Abdelhameed Khaled

    If  have multiple form how to disable drop down button  How could I disable the ability to select from multiple form again when he directed to a specific form link 

    so I want to disable the event listener of the from drop down 

     

    0
  • Gab
    Zendesk Customer Care
    Hi Abdelhameed, 
     
    I'm afraid there's no option to disable the drop down field for multiple forms. However, you can link directly to a ticket form in your help center to present a group of end users with a specific request form instead of asking them to select the appropriate form. If you require sign-in to submit tickets, the user will have to sign-in to see the form.
     
    Take a look at this article for your reference: Presenting ticket forms to end users
    0

Please sign in to leave a comment.

Powered by Zendesk