snowboard icon indicating copy to clipboard operation
snowboard copied to clipboard

Playground: request usability changes

Open sangar82 opened this issue 4 years ago • 1 comments

Hola!

Thanks again for this package and the latests changes. Every week is better!

I want to request changes for the playground feature: 1 - Add option to show open or closed the playground panel on startup. 2 - Add option or always show the optional parameters to send as unchecked.

Description: 1 - The panel playground is great, and it looks great too!! But in some cases, the panel is reducing the visibility and importance of the actual documentation and the parameters to be sent. For some users is hard to find the information fast. 2 - Sometimes there may be contrary optional parameters between them or optional parameters that if activated don't return anything for a one customer account. If they are optional, I think must be unchecked, on some cases this parameters are not needed for the user

Example:

playground: {
  enabled: true,
  visibility: closed, (open/closed, default open)
  optional_parameteres: unchecked (checked,unchecked, default checked)
  env: "development",
  environments: {
    development: {
      url: "http://localhost:8087/",
      playground: false
    },
    staging: {
      url: "https://staging.example.com/"
    }
  }
}

sangar82 avatar May 18 '20 07:05 sangar82

Thanks for suggestion @sangar82. I've just partially implemented it on https://github.com/bukalapak/snowboard/commit/a398e2b994609e579b32e272fdd02101ca8dc7b0.

You can hide the playground panel by adding hidden: true, like:

playground: {
  enabled: true,
  hidden: true,
  // ....rest of your config...
}

subosito avatar Dec 04 '20 03:12 subosito