Column Add Popup

Module Extensions

AdditionalData (Extended from @revolist/revogrid)

interface AdditionalData {
  /**
       * Column add popup plugin configuration.
       *
       * @deprecated Prefer the direct `grid.columnAddPopup` property.
       */
      columnAddPopup?: ColumnAddPopupConfig
}

---

HTMLRevoGridElement (Extended from global)

interface HTMLRevoGridElement {
  /**
       * Column add popup plugin configuration.
       */
      columnAddPopup?: ColumnAddPopupConfig
}

Plugin API

ColumnAddPopupPlugin

class ColumnAddPopupPlugin {
  open(trigger: HTMLElement, originalEvent: MouseEvent);

  destroy();
}

---

ColumnAddPopupTone

export type ColumnAddPopupTone =
  | 'green'
  | 'blue'
  | 'cyan'
  | 'red'
  | 'orange'
  | 'yellow'
  | 'violet'
  | 'pink'
  | 'gray';

---

ColumnAddPopupItem

interface ColumnAddPopupItem {
  id: string;
  label: string;
  description?: string;
  icon?: string;
  tone?: ColumnAddPopupTone;
  disabled?: boolean;
  selected?: boolean
}

---

ColumnAddPopupSection

interface ColumnAddPopupSection {
  title: string;
  items: ColumnAddPopupItem[]
}

---

ColumnAddPopupSelectContext

interface ColumnAddPopupSelectContext {
  item: ColumnAddPopupItem;
  selected: boolean;
  grid: HTMLRevoGridElement;
  originalEvent: MouseEvent;
  close: () => void
}

---

ColumnAddPopupItemStateContext

interface ColumnAddPopupItemStateContext {
  item: ColumnAddPopupItem;
  grid: HTMLRevoGridElement
}

---

ColumnAddPopupFooterContext

interface ColumnAddPopupFooterContext {
  grid: HTMLRevoGridElement;
  originalEvent: MouseEvent;
  close: () => void
}

---

ColumnAddPopupConfig

interface ColumnAddPopupConfig {
  sections?: ColumnAddPopupSection[];
  title?: string;
  footerLabel?: string;
  className?: string;
  isSelected?: (context: ColumnAddPopupItemStateContext) => boolean;
  onSelect?: (context: ColumnAddPopupSelectContext) => void;
  onFooterClick?: (context: ColumnAddPopupFooterContext) => void
}