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

Document new options parameter for buildShortcut function #44

Open
joshfarrant opened this issue Dec 4, 2018 · 2 comments
Open

Document new options parameter for buildShortcut function #44

joshfarrant opened this issue Dec 4, 2018 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@joshfarrant
Copy link
Owner

#16 added support for an optional options parameter to the buildShortcut function.

Currently, the supported options are:

buildShortcut([], {
  icon: {
    color: COLORS.LIGHT_BLUE // Or any color specified in src/meta/colors.ts
    glyph: GLYPHS.E9AE // Or any glyph specified in src/meta/glyphs.ts
  },
});

Currently, this functionality isn't documented anywhere. It would be useful to add some information about this feature (along with an example) to the README.

Additionally, we could improve the typedoc documentation comments for the buildShortcut function to include information about the options object and it's accepted types.

@joshfarrant joshfarrant added help wanted Extra attention is needed good first issue Good for newcomers labels Dec 4, 2018
@xAlien95
Copy link
Contributor

I inserted some information about this feature in my work in progress documentation fork. You can edit its temporary contents here: @xAlien95:docs :: Documentation/Metadata/ShortcutIcon/content.md.

@joshfarrant
Copy link
Owner Author

Looking really good!

Sent with GitHawk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants