> For the complete documentation index, see [llms.txt](https://the-sheet.gitbook.io/the-sheet-v2/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://the-sheet.gitbook.io/the-sheet-v2/docs/apis/sheet-stack-item.md).

# SheetStackItem

SheetStackItem is a component that represents an item in the sheet stack

When it opens, it will register itself to the sheet stack and obtain a z-index based on its position in the stack

When it closes, it will unregister itself from the sheet stack

## Props

| Prop name          | Type                                   | Required | Default     | Description                                                                                                         |
| ------------------ | -------------------------------------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------- |
| `ref`              | `RefObject<SheetStackItemApi \| null>` | false    | `undefined` | The ref of the stack item to use SheetStackItemApi                                                                  |
| `isOpen`           | `boolean`                              | true     | N/A         | Whether the stack item is open or not                                                                               |
| `close`            | `() => void`                           | true     | N/A         | The function to close the stack item                                                                                |
| `pushBehavior`     | `push` / `switch` / `replace`          | false    | `push`      | The behavior when pushing this item on top of the stack                                                             |
| `waitForFullyExit` | `boolean`                              | false    | `false`     | Whether to wait for a content to call `onFullyExit()` before fully unmount. Useful for bottom sheet close animation |
| `testID`           | `string`                               | false    | `undefined` | The test ID of the stack item (for testing purposes)                                                                |
| `children`         | `ReactNode`                            | false    | `undefined` | The children of the stack item                                                                                      |

### pushBehavior

* `push`: Pushes this item on top of the stack, keeping the previous one in the stack (default)
* `switch`: Pushes this item on top of the stack + Temporarily hides the previous top
* `replace`: Replaces the current top item in the stack with this one

## Ref methods (SheetStackItemApi)

* `hide()`: Temporarily hides the stack item (without unmounting)
* `show()`: Shows the stack item if it's hidden
* `putOnTop()`: Moves the stack item to the top of the stack (by removing and re-inserting it)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://the-sheet.gitbook.io/the-sheet-v2/docs/apis/sheet-stack-item.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
