@damilaredev/apexcharts-nuxt

ApexCharts Nuxt Module

Setup

Compatible with Nuxt >=3 and bridge Apexcharts is required to be installed in your project.

# yarn
yarn install apexcharts @damilaredev/apexcharts-nuxt

# npm
npm i apexcharts @damilaredev/apexcharts-nuxt

# pnpm
pnpm i apexcharts @damilaredev/apexcharts-nuxt

Add to Nuxt modules

export default defineNuxtConfig({
  modules: ['@damilaredev/apexcharts-nuxt'],
})

Props

type Props = {
  /**
   * Graph type prop
   *
   * @default 'line'
   *
   * @property
   * @name type
   * @type {string | undefined}
   */
  type?:
    | 'line'
    | 'area'
    | 'bar'
    | 'pie'
    | 'donut'
    | 'radialBar'
    | 'scatter'
    | 'bubble'
    | 'heatmap'
    | 'candlestick'
    | 'boxPlot'
    | 'radar'
    | 'polarArea'
    | 'rangeBar'
    | 'rangeArea'
    | 'treemap'

  /**
   * Graph config options
   *
   * @default '100%'
   *
   * @property
   * @name options
   * @type {ApexOptions | undefined}
   */
  options?: ApexOptions

  /**
   * Graph data prop
   *
   * @default '[]'
   *
   * @property
   * @name series
   * @type {ApexAxisChartSeries | ApexNonAxisChartSeries | undefined}
   */
  series?: ApexAxisChartSeries | ApexNonAxisChartSeries

  /**
   * Graph width
   *
   * @default '100%'
   *
   * @property
   * @name width
   * @type {string | number | undefined}
   */
  width?: string | number

  /**
   * Graph height
   *
   * @default '100%'
   *
   * @property
   * @name height
   * @type {string | number | undefined}
   */
  height?: string | number
}

Example

Check out the GitHub example repo for sample usage.