Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Good First Issue: Ability to customise the sls-dev-tools HQ display #236

Open
mansurpasha opened this issue May 11, 2020 · 0 comments
Open
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@mansurpasha
Copy link
Contributor

Why: As the tool has a lot of features, being able to tailor the tool to your current project, by resizing or rearranging the grid panels, allows users to maximise its usefulness and minimise distractions.

Expected Behaviour:

  • using a template as an example, write your desired panel sizes in slsdevtools.config.js
  • on running the tool, if there is a config file then the grid uses the given sizes to resize/rearrange each panel

External Library Used:

Scope Limit:

  • Use the config file to set the width and height of panels, as well as their position
  • It's not necessary to check if all rows and columns align correctly
  • In a future issue/pr, the config may allow components to be removed entirely and for users to customise the order in which components are navigated using tab

Changes needed:

  • Add a section to the config file for customising the layout, with a property for each component
  • Update the slsdevtools.config.js.dst template file to show usage of this feature
  • Where each component is added to the layout grid, use the parameters in the config file if specified, otherwise use the default
  • Components are added using the grid.set() function which takes (row, col, rowSpan, colSpan, obj, opts) as arguments
  • There are 8 panels in the tool, the grid.set() calls for each are linked below:
  • update the readme docs

image

@mansurpasha mansurpasha added enhancement New feature or request good first issue Good for newcomers labels May 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant