action row docs

This commit is contained in:
MapleLeaf
2021-12-29 11:41:05 -06:00
parent acbaad145e
commit f3aab8f425
2 changed files with 22 additions and 0 deletions

View File

@@ -4,10 +4,31 @@ import { ReacordElement } from "../../internal/element.js"
import type { MessageOptions } from "../../internal/message"
import { Node } from "../../internal/node.js"
/**
* Props for an action row
* @category Components
*/
export type ActionRowProps = {
children?: ReactNode
}
/**
* An action row is a top-level container for message components.
*
* You don't need to use this; Reacord automatically creates action rows for you.
* But this can be useful if you want a specific layout.
*
* ```tsx
* // put buttons on two separate rows
* <ActionRow>
* <Button onClick={handleFirst}>First</Button>
* </ActionRow>
* <Button onClick={handleSecond}>Second</Button>
* ```
*
* @category Components
* @see https://discord.com/developers/docs/interactions/message-components#action-rows
*/
export function ActionRow(props: ActionRowProps) {
return (
<ReacordElement props={props} createNode={() => new ActionRowNode(props)}>

View File

@@ -37,6 +37,7 @@
- [ ] combine `MessageOptions` and `Message` into a single message object (?)
- [x] consider always calling `deferUpdate` on component interactions
- [ ] more unit tests instead of integration tests probably
# cool ideas / polish