@graphenedata/cli 0.0.4 → 0.0.6

package/dist/docs/data_apps/components/maps/us-map.md

@@ -1,167 +0,0 @@
----
-title: US Map
-description: Compare a metric across US states using a flat choropleth map.
----
-
-Compare a metric across US states using a flat choropleth map. For other regions see the more general [Area Map](/components/maps/area-map) component.
-
-**Example:**
-
-```html
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-/>
-```
-
-## Examples
-
-### Color Scales
-
-`colorScale=info`
-
-**Example:**
-
-````html
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-    colorScale=info
-/>
-````
-
-`colorScale=positive`
-
-**Example:**
-
-````html
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-    colorScale=positive
-/>
-````
-
-`colorScale=negative`
-
-**Example:**
-
-````html
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-    colorScale=negative
-/>
-````
-
-### Custom Color Scale
-
-**Example:**
-
-```svelte
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-    colorScale={['maroon','white','#1c0d80']}
-    legend=true
-/>
-```
-
-### Legend
-
-#### Default
-
-**Example:**
-
-```html
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-    legend=true
-/>
-```
-
-#### With Filter
-
-**Example:**
-
-````svelte
-<USMap
-    data="state_population"
-    state=state_name
-    value=population
-    colorScale={['maroon','white','#1c0d80']}
-    legend=true
-    filter=true
-/>
-````
-
-### Links
-
-**Example:**
-
-```html
-<USMap
-	data="state_current"
-	state=state
-	value=value
-	abbreviations=true
-	link=state_link
-	title="Sales by State"
-	subtitle={{most_recent_month[0].month}}
-/>
-```
-
-### State Abbreviations
-
-**Example:**
-
-```html
-<USMap data="map_data" state=state_abbrev value=sales_usd abbreviations=true />
-```
-
-## Options
-
-### Data
-
-| Property | Required | Type | Description |
-|----------|----------|------|-------------|
-| data | ✓ | query name | Query name, wrapped in curly braces |
-| state | ✓ | column name | Column to be used as the name for each state |
-| abbreviations | | false/true (default: false) | If true, map will look for two letter abbreviations rather than full names |
-| value | ✓ | column name | Column to be used as the value determining the colour of each state |
-| colorScale | | | Colour scale to be used. To use a custom color palette, see the `colorPalette` prop (default: info) |
-| colorPalette | | array of color codes (can be CSS, hex, RGB, HSL) | Custom color palette to use for setting state colors. Overrides `colorScale`. E.g., `{['#cf0d06','#eb5752','#e88a87']}` |
-| min | | number | Minimum value for the colour scale. Anything below the minimum will be shown in the same colour as the min value |
-| max | | number | Maximum value for the colour scale. Anything above the maximum will be shown in the same colour as the max value |
-| title | | string | Title appearing above the map. Is included when you click to save the map image |
-| subtitle | | string | Subtitle appearing just above the map. Is included when you click to save the map image |
-| link | | column name | Column containing links. When supplied, allows you to click each state on the map and navigate to the link |
-| fmt | | Excel-style format \| built-in format \| custom format | Format to use for values ([see available formats](/core-concepts/formatting)) |
-| legend | | true/false (default: false) | Whether to show a legend at the top of the map |
-| filter | | true/false (default: false) | Whether to include filter controls on the legend. Can only be used when legend = true |
-| emptySet | | error/warn/pass (default: error) | Sets behaviour for empty datasets. Can throw an error, a warning, or allow empty. When set to `error`, empty datasets will block builds in `build:strict`. Note this only applies to initial page load - empty datasets caused by input component changes (dropdowns, etc.) are allowed. |
-| emptyMessage | | string (default: "No records") | Text to display when an empty dataset is received - only applies when `emptySet` is `warn` or `pass`, or when the empty dataset is a result of an input component change (dropdowns, etc.). |
-| renderer | | canvas/svg (default: canvas) | Which chart renderer type (canvas or SVG) to use. See ECharts' [documentation on renderers](https://echarts.apache.org/handbook/en/best-practices/canvas-vs-svg). |
-| downloadableData | | true/false (default: true) | Whether to show the download button to allow users to download the data |
-| downloadableImage | | true/false (default: true) | Whether to show the button to allow users to save the chart as an image |
-
-### Custom Echarts Options
-
-| Property | Type | Description |
-|----------|------|-------------|
-| echartsOptions | `{{exampleOption:'exampleValue'}}` | Custom Echarts options to override the default options. See [reference page](/components/charts/echarts-options) for available options. |
-| seriesOptions | `{{exampleSeriesOption:'exampleValue'}}` | Custom Echarts options to override the default options for all series in the chart. This loops through the series to apply the settings rather than having to specify every series manually using `echartsOptions` See [reference page](/components/charts/echarts-options) for available options. |
-| printEchartsConfig | true/false (default: false) | Helper prop for custom chart development - inserts a code block with the current echarts config onto the page so you can see the options used and debug your custom options |
-
-### Interactivity
-
-| Property | Type | Description |
-|----------|------|-------------|
-| connectGroup | | Group name to connect this chart to other charts for synchronized tooltip hovering. Charts with the same `connectGroup` name will become connected |

package/dist/docs/data_apps/components/ui/accordion.md

@@ -1,116 +0,0 @@
----
-title: Accordion
-description: Organize content into collapsible sections.
----
-
-Use accordions to organize content into collapsible sections.
-
-**Example:**
-
-```markdown 
-<Accordion>
-  <AccordionItem title="Item 1">
-
-    This is the first item's accordion body.
-
-    You can use **markdown** here too!
-
-    Make sure to include an empty line after the component if you want to use markdown.
-
-  </AccordionItem>
-  <AccordionItem title="Item 2">
-
-    This is the second item's accordion body with <b>bold text</b>.
-
-  </AccordionItem>
-  <AccordionItem title="Item 3">
-
-    This is the third item's accordion body.
-
-  </AccordionItem>
-</Accordion>
-```
-
-## Examples 
-
-### Single Accordion 
-
-**Example:**
-
-```markdown 
-<Accordion single>
-  <AccordionItem title="Item 1">
-    <p>Content 1</p>
-  </AccordionItem>
-  <AccordionItem title="Item 2">
-    <p>Content 2</p>
-  </AccordionItem>
-  <AccordionItem title="Item 3">
-    <p>Content 3</p>
-  </AccordionItem>
-</Accordion>
-```
-
-### Overriding Styles 
-
-Use the `class` options to override the styles on the accordion. 
-
-**Example:**
-
-```markdown 
-<Accordion class="rounded-xl bg-gray-50 px-4 mt-4">
-  <AccordionItem title="Item 1" class="border-none">
-    <p>Content 1</p>
-  </AccordionItem>
-  <AccordionItem title="Item 2" class="border-none">
-    <p>Content 2</p>
-  </AccordionItem>
-  <AccordionItem title="Item 3" class="border-none">
-    <p>Content 3</p>
-  </AccordionItem>
-</Accordion>
-```
-
-### Title Slot  
-
-Pass components into the accordion title by using the slot `title`. 
-
-```growth
-
-select 0.366 as positive, -0.366 as negative
-
-```
-
-**Example:**
-
-```markdown 
-<Accordion>
-  <AccordionItem title="Item 1">
-    <span slot='title'>Custom Title <Value data="growth" fmt=pct1 /></span>
-    Content 1 
-  </AccordionItem>
-  <AccordionItem title="Item 2">
-    <p>Content 2</p>
-  </AccordionItem>
-  <AccordionItem title="Item 3">
-    <p>Content 3</p>
-  </AccordionItem>
-</Accordion>
-```
-
-## Options
-
-### Accordion
-
-| Property | Description | Options | Required |
-|----------|-------------|---------|----------|
-| single | When true, only a single accordian item can be open at once. | true, false | false |
-| class | Pass custom classes to control the styling of the accordion body. Supports [tailwind classes](https://tailwindcss.com). | string | false |
-
-### AccordionItem
-
-| Property | Description | Required |
-|----------|-------------|----------|
-| title | The title of the accordion item. This will be displayed as the header. | true |
-| class | Pass custom classes to control the styling of an accordion item. Supports [tailwind classes](https://tailwindcss.com). | false |
-| description | Adds an info icon with description tooltip on hover | false |

package/dist/docs/data_apps/components/ui/alert.md

@@ -1,37 +0,0 @@
----
-title: Alert
-description: Display a message in a styled container on the page.
----
-
-Use alerts to display a message in a styled container on the page.
-
-**Example:**
-
-```markdown
-<Alert>
-This is a default alert
-</Alert>
-
-<Alert status="info">
-This is a informational alert
-</Alert>
-
-<Alert status="positive">
-This is a positive alert
-</Alert>
-
-<Alert status="warning">
-This is a warning alert
-</Alert>
-
-<Alert status="negative">
-This is a negative alert
-</Alert>
-```
-
-## Options
-
-| Property | Description | Options |
-|----------|-------------|---------|
-| status | Changes the color of the alert | info, positive, warning, negative |
-| description | Adds an info icon with description tooltip on hover | string |

package/dist/docs/data_apps/components/ui/big-link.md

@@ -1,19 +0,0 @@
----
-title: Big Link
-description: Display a url link in a styled container.
----
-
-Use big links to display a url link in a styled container. To style links like Buttons, use a [Link Button](/components/ui/link-button).
-
-**Example:**
-
-```markdown
-<BigLink url='/components/ui/big-link'>My Big Link</BigLink> 
-```
-
-## Options
-
-| Property | Description | Required | Options |
-|----------|-------------|----------|---------|
-| url | Renders a link that, when clicked, navigates to the specified URL. It can accept either a full external link (e.g. `https://google.com`) or link to another page within your evidence app (e.g. `/sales/performance`). | true | string |
-| href | href deprecated, please use url | false | string |

package/dist/docs/data_apps/components/ui/details.md

@@ -1,58 +0,0 @@
----
-title: Details
-description: Add a collapsible section of markdown content that can be expanded to reveal more information.
----
-
-The details component allows you to add a collapsible section to your markdown. This is useful for adding additional information that you don't want to be visible by default, but can be expanded by the reader.
-
-## Default state
-
-**Example:**
-
-````markdown
-<Details title="Definitions">
-    
-    Definition of metrics in Solutions Targets
-
-    ### Time to Proposal
-
-    Average number of days it takes to create a proposal for a customer
-
-    *Calculation:*
-    Sum of the number of days it took to create each proposal, divided by the number of proposals created
-
-    *Source:*
-    Hubspot
-
-</Details>
-````
-
-## Expanded state
-
-**Example:**
-
-```markdown
-<Details title="Definitions" open=true>
-    
-    Definition of metrics in Solutions Targets
-
-    ### Time to Proposal
-
-    Average number of days it takes to create a proposal for a customer
-
-    *Calculation:*
-    Sum of the number of days it took to create each proposal, divided by the number of proposals created
-
-    *Source:*
-    Hubspot
-
-</Details>
-```
-
-## Options
-
-| Property | Description | Options | Default |
-|----------|-------------|---------|---------|
-| title | The text shown next to the triangle icon. | string | Details |
-| open | Whether expanded by default. | true, false | false |
-| printShowAll | On print/PDF, the Details component will expand by default. Turn this off to leave the component collapsed in print. | true, false | true |

package/dist/docs/data_apps/components/ui/download-data.md

@@ -1,41 +0,0 @@
----
-title: Download Data
-description: Display a standalone button to download a specified dataset as a CSV file.
----
-
-Display a standalone button to download a specified dataset as a CSV file. Note that this component is not visible on small screen widths.
-
-```categories
-select category, sum(sales) as sales from needful_things.orders
-group by all
-order by sales desc
-```
-
-**Example:**
-
-```svelte
-<DownloadData data="categories"/>
-```
-
-## Examples
-
-### Custom Text
-
-```svelte
-<DownloadData data="categories" text="Click Here"/>
-```
-
-### Custom Query ID
-
-```svelte
-<DownloadData data="categories" queryID=my_file/>
-```
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| data | Query name, wrapped in curly braces | true | query name | - |
-| display | Whether link is visible. If using as part of a custom component, you can pass a variable representing the hover state of your component to control visibility. | false | ['true', 'false'] | "true" |
-| text | Label to show on the link | false | string | "Download" |
-| queryID | Label to include as the start of the CSV filename. If no queryID is supplied, "evidence_download" is used. | false | string | - |

package/dist/docs/data_apps/components/ui/embed.md

@@ -1,47 +0,0 @@
----
-title: Embed
-description: Embed content onto your page, like videos or iframes from other applications
----
-
-Use the `Embed` component to display external content, such as videos, maps, or other embeddable media, within your markdown pages. This component allows you to customize dimensions, add borders, and ensure responsive styling. 
-
-## Default usage
-
-```markdown
-<Embed 
-    url="https://www.youtube.com/embed/UiCioBZ5IDU?si=dychrQurRTlhz9DN"
-    title="Sample Video"
-/>
-```
-
-### Custom size
-
-```markdown
-<Embed 
-    url="https://www.youtube.com/embed/UiCioBZ5IDU?si=dychrQurRTlhz9DN"
-    title="Sample Video"
-    width=800
-    height=450
-/>
-```
-
-### No border
-
-```markdown
-<Embed 
-    url="https://www.youtube.com/embed/UiCioBZ5IDU?si=dychrQurRTlhz9DN"
-    title="Sample Video"
-    border=false
-/>
-```
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| url | The URL of the embeddable content. | true | - | - |
-| title | A description or title for the embed, useful for accessibility purposes. | false | - | "" |
-| width | The width of the embed (in pixels). | false | number | "100%" |
-| height | The height of the embed (in pixels). | false | number | 400 |
-| border | Whether to display a border around the embed | false | ['true', 'false'] | "true" |
-| class | Pass custom classes to control the styling of the embed wrapper. Supports [Tailwind classes](https://tailwindcss.com). | false | - | - |

package/dist/docs/data_apps/components/ui/grid.md

@@ -1,45 +0,0 @@
----
-title: Grid
-description: Arrange components in a grid with a specified number of columns.
----
-
-Use the grid component to arrange components in a grid with a specified number of columns. On smaller screen widths, the grid will stack the components vertically to maintain readability.
-
-
-**Example:**
-
-```svelte
-<Grid cols=2>
-    <LineChart data="orders_by_category" x=order_month y=orders/>
-    <BarChart data="orders_by_category" x=order_month y=orders fillColor=#00b4e0/>
-    <ScatterPlot data="orders_by_category" x=order_month y=orders fillColor=#015c08/>
-    <AreaChart data="orders_by_category" x=order_month y=orders fillColor=#b8645e lineColor=#b8645e/>
-</Grid>
-```
-
-## Group Component
-
-To include multiple items inside one grid cell, use the `Group` component to wrap the items you want to include in that cell.
-
-For example:
-
-**Example:**
-
-```html
-<Grid cols=2>
-    <LineChart data="orders_by_category" x=order_month y=orders/>
-   <Group>
-      Some text
-    <BarChart data="orders_by_category" x=order_month y=orders fillColor=#00b4e0/>
-   </Group>
-</Grid>
-```
-
-This will stack "some text" above the bar chart, rather than giving it it's own cell.
-
-## Options
-
-| Property | Description | Options | Default |
-|----------|-------------|---------|---------|
-| cols | Number of columns in the grid on a full size screen | 1, 2, 3, 4, 5, 6 | 2 |
-| gapSize | Space between grid elements | none, sm, md, lg | md |

package/dist/docs/data_apps/components/ui/image.md

@@ -1,61 +0,0 @@
----
-title: Image
-description: Display an image on your page and control dimensions & styling
----
-
-> **Note:** You can also use [markdown syntax for images](/reference/markdown#images). This component is useful when you need to customize the dimensions or styling of the image.
-
-The `Image` component allows you to add responsive and styled images to your markdown pages. This component is useful for embedding images with optional alignment, width, and height settings, and includes accessibility features through the description attribute.
-
-## Examples
-
-### Custom size
-
-**Example:**
-
-```markdown
-<Image 
-    url="https://raw.githubusercontent.com/evidence-dev/media-kit/refs/heads/main/png/wordmark-gray-800.png"
-    description="Sample placeholder image"
-    height=80
-/>
-```
-
-### Aligned Left
-
-**Example:**
-
-```markdown
-<Image 
-    url="https://raw.githubusercontent.com/evidence-dev/media-kit/refs/heads/main/png/wordmark-gray-800.png"
-    description="Sample placeholder image"
-    height=80
-    align="left"
-/>
-```
-
-### With Border & Custom Padding
-
-**Example:**
-
-```markdown
-<Image 
-    url="https://raw.githubusercontent.com/evidence-dev/media-kit/refs/heads/main/png/wordmark-gray-800.png" 
-    description="Sample placeholder image"
-    height=80
-    border=true 
-    class="p-4"
-/> 
-```
-
-## Options
-
-| Property | Description | Required | Options | Default |
-|----------|-------------|----------|---------|---------|
-| url | The URL of the image. | true | string | - |
-| description | The description of the image for accessibility purposes. | false | string | - |
-| width | The width of the image (in pixels) | false | number | - |
-| height | The height of the image (in pixels) | false | number | - |
-| border | Whether to display a border around the image | false | true, false | false |
-| align | The alignment of the image | false | center, left, right | center |
-| class | Pass custom classes to control the styling of an accordion item. Supports [tailwind classes](https://tailwindcss.com). | false | string | - |

package/dist/docs/data_apps/components/ui/info.md

@@ -1,47 +0,0 @@
----
-title: Info
-description: Display an info icon with descriptive tooltip
----
-
-The Info component can be used on a standalone basis as shown on this page, or can be used as part of other components which support the `description` prop (including Column, BigValue, Value, and more).
-
-**Example:**
-
-```markdown
-Data was sourced from the World Bank <Info description="World Economic Indicators dataset from past 12 months" />
-```
-
-## Examples
-
-### Inline Usage
-
-**Example:**
-
-```markdown
-Data was sourced from the World Bank <Info description="World Economic Indicators dataset from past 12 months" />
-```
-
-### Theme Color
-
-**Example:**
-
-```markdown
-Data was sourced from the World Bank <Info description="World Economic Indicators dataset from past 12 months" color="primary" />
-```
-
-### Custom Color
-
-**Example:**
-
-```markdown
-Data was sourced from the World Bank <Info description="World Economic Indicators dataset from past 12 months" color="red" />
-```
-
-## Options
-
-| Property | Description | Required | Options | Default |
-|----------|-------------|----------|---------|---------|
-| description | Text content for the tooltip. | true | string | - |
-| color | Color of the tooltip content. | false | string | base-content-muted |
-| size | Size of the icon. | false | number | 4 |
-| className | Custom class names for the tooltip trigger. | false | string | - |

package/dist/docs/data_apps/components/ui/last-refreshed.md

@@ -1,28 +0,0 @@
----
-title: Last Refreshed
-description: Display text indicating the last time the data was refreshed.
----
-
-Displays the last time the data was refreshed. This component is useful for showing users how up-to-date the data is.
-
-**Example:**
-
-```markdown
-<LastRefreshed/>
-```
-
-## Examples
-
-### Alternative Prefix
-
-```markdown
-<LastRefreshed prefix="Data last updated"/>
-```
-
-## Options
-
-| Name | Description | Required | Options | Default |
-|------|-------------|----------|---------|---------|
-| prefix | Text to display before the last refreshed time | false | string | "Last refreshed" |
-| printShowDate | On print/PDF, will show the date and time rather than "X hours ago". | false | ['true', 'false'] | "true" |
-| dateFmt | If `printShowDate` is `true`, format to use for the date ([see available formats](/core-concepts/formatting)) | false | Excel-style format \| built-in format \| custom format | - |

package/dist/docs/data_apps/components/ui/link-button.md

@@ -1,20 +0,0 @@
----
-title: Link Button
-description: Style a link as a button.
----
-
-Use the link button component to style a link as a button.
-
-**Example:**
-
-```markdown
-<LinkButton url='/components/ui/link-button'>
-  My Link Button
-</LinkButton>
-```
-
-## Options
-
-| Property | Description | Required | Options |
-|----------|-------------|----------|---------|
-| url | Renders a button that, when clicked, navigates to the specified URL. It can accept either a full external link (e.g. `https://google.com`) or link to another page within your evidence app (e.g. `/sales/performance`). | true | string |