# SummaryOnly Plugin for Obsidian

[![GitHub Release](https://img.shields.io/github/v/release/TylerCarrol/obsidian-summary-only?logo=github&sort=semver)](https://github.com/TylerCarrol/obsidian-summary-only/releases/latest)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/TylerCarrol/obsidian-summary-only/blob/main/LICENSE)
[![Lint](https://github.com/TylerCarrol/obsidian-summary-only/actions/workflows/lint.yml/badge.svg)](https://github.com/TylerCarrol/obsidian-summary-only/actions/workflows/lint.yml)
[![Test](https://github.com/TylerCarrol/obsidian-summary-only/actions/workflows/test.yml/badge.svg)](https://github.com/TylerCarrol/obsidian-summary-only/actions/workflows/test.yml)
[![Scc Count Badge](https://sloc.xyz/github/TylerCarrol/obsidian-summary-only?category=code)](https://github.com/TylerCarrol/obsidian-summary-only?category=code)
[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-yellow.svg)](https://buymeacoffee.com/tylercarrol)

SummaryOnly adds a **Summary only** view to Obsidian Bases. The view hides the
rows and instead, just displays the summaries as cards.

## Examples

##### Summary
![SummaryOnly-Example](./images/example-summary-only.png)

##### Table
> Source data

![SummaryOnly-Example](./images/example-table.png)

## Install for development

1. Install dependencies:
   ```bash
   npm install
   ```
2. Build the plugin:
   ```bash
   npm run build
   ```
3. Copy `main.js`, `manifest.json`, and `styles.css` to:
   ```text
   <Vault>/.obsidian/plugins/summary-only/
   ```
4. In Obsidian, enable **Settings → Community plugins → summary-only**.

For watch mode during development:

```bash
npm run dev
```

## Fastest way to try it

This repository includes a ready-made demo vault in `/summary-only-demo-vault`.

- Windows/PowerShell:
  ```powershell
  .\scripts\build-to-demo-vault.ps1
  ```
- Any platform:
  1. Run `npm run build`
  2. Copy `main.js`, `manifest.json`, and `styles.css` to `summary-only-demo-vault/.obsidian/plugins/summary-only/`
  3. Open `summary-only-demo-vault` in Obsidian

See `summary-only-demo-vault/README.md` for a guided walkthrough.

## Use the Summary only view

1. Open a `.base` file in Obsidian.
2. Open the view menu in the top-left corner.
3. Add a view and select **Summary only**.
4. Configure summaries for the properties that you want to display.

Each card shows the property name, the summary name, and the calculated value.
Use the view settings menu to adjust **Card width** and **Card height** with
sliders. Enable **Show summary editor** to display every property in the view
and choose a summary for each card.

### Grouped summaries

Select a property in the Base view's **Group by** setting. SummaryOnly shows
a section for each group, with one card per summary property. Each card
calculates its summary from that group's entries. Sections follow the Base
group order. Entries without a group value appear under **No value**.

The **All** section appears first by default. Its cards summarize all entries
in the current Base result. Turn off **Show All summary** in the view settings
to show only the group sections. This setting applies to each view separately.
Without **Group by**, the view keeps its original layout.

Summary choices apply to every group. A change in any card's summary editor
updates that property in all sections.