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

API improvements #134

Open
NateBaldwinDesign opened this issue Sep 2, 2021 · 0 comments
Open

API improvements #134

NateBaldwinDesign opened this issue Sep 2, 2021 · 0 comments
Labels
enhancement New feature or request npm packages Issues related to the leonardo npm packages

Comments

@NateBaldwinDesign
Copy link
Collaborator

Description

Refine the API props and options for Leonardo to be more intuitive and consistent.

Considering there are other tools out there (including the d3 and chroma.js libraries) that have similar options, conforming to similar prop names or casing styles would make this tool more intuitive for consumers who are familiar with those tools.

For example:

  • Lower case colorspace names: 'lch' instead of 'LCH'
  • colorspace prop should either be camel case, or use a more literal term like interpolate/mode
  • output may be better surfaced as format (eg, d3 formatRgb)

Overall evaluation and comparison of prop names and values should be done beyond those examples.

Why do you need this feature?

Solidify the API for Leonardo by relating to existing language, props, and values expressed in other similar tools or industry standards.

Leonardo package and version

Additional context

@NateBaldwinDesign NateBaldwinDesign added enhancement New feature or request npm packages Issues related to the leonardo npm packages labels Sep 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request npm packages Issues related to the leonardo npm packages
Projects
None yet
Development

No branches or pull requests

1 participant