Skip to content

chore: add group to readme#60

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.

Sign up for GitHub

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
natemoo-re merged 2 commits into from
Feb 17, 2023
Merged

chore: add group to readme #60

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
007f125
chore: update readme
cpreston321 Feb 17, 2023
68c4867
chore: don't need to changeset since it's docs
cpreston321 Feb 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions packages/prompts/README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -120,3 +120,36 @@ s.start('Installing via npm');
// Do installation
s.stop('Installed via npm');
```

## Utilities

### Grouping

Grouping prompts together is a great way to keep your code organized. This accepts a JSON object with a name that can be used to reference the group later. The second argument is an optional but has a `onCancel` callback that will be called if the user cancels one of the prompts in the group.

@ulkenulkenFeb 17, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

This accepts a JSON object with a name that can be used to reference the group later.

I don't understand this part. Care to explain?

To me, there's only one group of named prompts.

@cpreston321cpreston321Feb 17, 2023

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

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

it was meaning to say the first argument accepts an object and for each key correlates to a prompt function that then can be referenced within the return.

Might need to change the wording but if you have any suggestions to simplify I'll make those changes.

@ulkenulkenFeb 17, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Right, then we're on the same page regarding intended meaning. I don't think that's what it says right now, though.

It states the name can be used to reference the group, not the prompt.

I'll see what I can come up with.

On a related note, I think explanations of API parameters would be better suited for more structural API docs, but that's a whole other beast.

@ulkenulkenFeb 21, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

#68


```js
import * as p from '@clack/prompts'

const group = await p.group({
name: () => p.text({ message: "What is your name?" }),
age: () => p.text({ message: "What is your age?" }),
color: ({ results }) => p.multiselect({
message: `What is your favorite color ${results.name}?`,
options: [
{ value: 'red', label: 'Red' },
{ value: 'green', label: 'Green' },
{ value: 'blue', label: 'Blue' },
],
})
},
{
// On Cancel callback that wraps the group
// So if the user cancels one of the prompts in the group this function will be called
onCancel: ({ results }) => {
p.cancel('Operation cancelled.')
process.exit(0)
}
})

console.log(group.name, group.age, group.color)
```