Composables
useGSheetRow
Extract a single row by index from a spreadsheet range.
The useGSheetRow composable retrieves a single row from a range by its zero-based index.
Signature
function useGSheetRow<T = any>(
range: string,
rowIndex: number,
options?: ComposablesOptions
): {
data: Ref<T | null>
pending: Ref<boolean>
error: Ref<FetchError | null>
refresh: () => Promise<void>
execute: () => Promise<void>
status: Ref<'idle' | 'pending' | 'success' | 'error'>
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
range | string | Yes | Cell range in A1 notation. |
rowIndex | number | Yes | Zero-based index of the target row within the range. |
options | ComposablesOptions | No | Additional composable options. |
Basic Example
pages/profile.vue
<script setup lang="ts">
// Retrieves index 1 (second row in range A1:C10)
const { data: userRow, pending } = await useGSheetRow('A1:C10', 1, {
sheet: 'users'
})
</script>
<template>
<div v-if="pending">Loading user...</div>
<div v-else-if="userRow">
<p>User ID: {{ userRow[0] }}</p>
<p>Name: {{ userRow[1] }}</p>
<p>Role: {{ userRow[2] }}</p>
</div>
</template>