Skip to content

Feat/snippets #1823

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

Merged
merged 7 commits into from
Feb 13, 2022
Merged

Feat/snippets #1823

merged 7 commits into from
Feb 13, 2022

Conversation

Inbal-Tish
Copy link
Collaborator

@Inbal-Tish Inbal-Tish commented Feb 7, 2022

Description

Snippets - adding "snippet" key to the api.json and adding it to docs site build.

Changelog

Snippets - adding "snippet" key to the api.json and adding it to docs site build.

Copy link
Collaborator

@ethanshar ethanshar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I've been meaning to add something similar (:

Anyway ,most of the snippets are pretty hollow IMO, I think we should have a team effort to make them a bit more detailed.

Anyway, is there a way to convert the placeholders (e.g $1) in the snippets to a meaningful values?

It'll be great if for example we can have a snippet like this
<Card backgroundColor={Colors.blue30} />
instead of
<Card backgroundColor={} />

Inbal-Tish and others added 2 commits February 9, 2022 09:15
Co-authored-by: Ethan Sharabi <[email protected]>
Co-authored-by: Ethan Sharabi <[email protected]>
@Inbal-Tish
Copy link
Collaborator Author

Looks great! I've been meaning to add something similar (:

Anyway ,most of the snippets are pretty hollow IMO, I think we should have a team effort to make them a bit more detailed.

Anyway, is there a way to convert the placeholders (e.g $1) in the snippets to a meaningful values?

It'll be great if for example we can have a snippet like this <Card backgroundColor={Colors.blue30} /> instead of <Card backgroundColor={} />

The $ signed are used in the code snippets extension to mark the position of a cursor and move it along using the tab key. Do we prefer to give that up in favor of a value or present the value in the code snippet extension alongside the cursor?

@ethanshar
Copy link
Collaborator

Looks great! I've been meaning to add something similar (:
Anyway ,most of the snippets are pretty hollow IMO, I think we should have a team effort to make them a bit more detailed.
Anyway, is there a way to convert the placeholders (e.g $1) in the snippets to a meaningful values?
It'll be great if for example we can have a snippet like this <Card backgroundColor={Colors.blue30} /> instead of <Card backgroundColor={} />

The $ signed are used in the code snippets extension to mark the position of a cursor and move it along using the tab key. Do we prefer to give that up in favor of a value or present the value in the code snippet extension alongside the cursor?

Yes, I think the cursor thing is a nice to have..
But personally as a user, I'd prefer to have a more practical example (both in the docs and snippet extension) than a placeholder that Im not sure what to put there.

@Inbal-Tish
Copy link
Collaborator Author

Looks great! I've been meaning to add something similar (:
Anyway ,most of the snippets are pretty hollow IMO, I think we should have a team effort to make them a bit more detailed.
Anyway, is there a way to convert the placeholders (e.g $1) in the snippets to a meaningful values?
It'll be great if for example we can have a snippet like this <Card backgroundColor={Colors.blue30} /> instead of <Card backgroundColor={} />

The $ signed are used in the code snippets extension to mark the position of a cursor and move it along using the tab key. Do we prefer to give that up in favor of a value or present the value in the code snippet extension alongside the cursor?

Yes, I think the cursor thing is a nice to have.. But personally as a user, I'd prefer to have a more practical example (both in the docs and snippet extension) than a placeholder that Im not sure what to put there.

Ok. I'll add a value before the $ that's how we'll have both an example and the cursor mark

@ethanshar ethanshar merged commit 96b4977 into master Feb 13, 2022
@Inbal-Tish Inbal-Tish deleted the feat/snippets branch February 20, 2022 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants