@gm-pc/keyboard 1.26.2-beta.0 → 1.27.1-beta.0

package/src/types.ts

@@ -1,87 +1,87 @@
-import { TableXColumn } from '@gm-pc/table-x'
-
-type KeyboardTableXColumn = {
-  isKeyboard?: boolean
-} & TableXColumn
-
-interface KeyboardTableXProps {
-  /* 通过 id 来确定本单元格内通信，避免多表格时混了。请确保 id 唯一 */
-  id: string
-  columns: KeyboardTableXColumn[]
-  /** 按下键是否允许增加一行数据 */
-  allowAddRowOnDownKey?: boolean
-  /* 增加一行数据 */
-  onAddRow(): void
-  onBeforeDispatch?(options: {
-    actionName: string
-    to: { rowKey: number; columnKey: string }
-    from: { rowKey: number; columnKey: string }
-  }): boolean
-}
-
-type KeyboardDirection = 'left' | 'right' | 'up' | 'down'
-interface KeyboardCustomEvent {
-  cellKey: string
-  direction: KeyboardDirection
-}
-
-interface KeyboardWrapData {
-  id: string
-  fixedWidths: {
-    leftFixedWidth: number
-    rightFixedWidth: number
-  }
-}
-
-interface KeyboardCellProps {
-  /** wrap 传过来的数据 */
-  wrapData: KeyboardWrapData
-  /** Cell 的身份标志，让 Wrap 更方便找到 */
-  cellKey: string
-  /** Wrap 要 focus 到单元格的时候触发 onFocus，请实现此功能 */
-  onFocus(): void
-  /** 表格多的时候需要滚到视窗 */
-  onScroll(data: KeyboardWrapData['fixedWidths']): void
-  /** 是否具有响应能力 */
-  disabled?: boolean
-}
-
-interface WrapProps {
-  /** 通过 id 来确定本单元格内通信，避免多表格时混了，请确保 id 唯一 */
-  id: string
-  /** 增加一行数据 */
-  onAddRow(): void
-  onBeforeDispatch?(options: {
-    actionName: string
-    to: { rowKey: number; columnKey: string }
-    from: { rowKey: number; columnKey: string }
-  }): boolean
-
-  /** 按下键是否允许增加一行数据 */
-  allowAddRowOnDownKey?: boolean
-
-  /** Wrap 需要知道字段集合，以便能找到相应的单元格，请确保表格的顺序一致 */
-  columnKeys: string[]
-  /** Wrap 需要知道有多少行，以便能找到相应的单元格，同时必要时会触发 onAddRow，告知调用方需要增加一行数据 */
-  dataLength: number
-  fixedWidths: {
-    leftFixedWidth: number
-    rightFixedWidth: number
-  }
-}
-
-type MoreSelectRef = {
-  /**  默认搜索 */
-  handleInitSearch: (q?: string) => void
-}
-
-export type {
-  KeyboardCellProps,
-  WrapProps,
-  KeyboardTableXProps,
-  KeyboardTableXColumn,
-  KeyboardCustomEvent,
-  KeyboardDirection,
-  KeyboardWrapData,
-  MoreSelectRef,
-}
+import { TableXColumn } from '@gm-pc/table-x'
+
+type KeyboardTableXColumn = {
+  isKeyboard?: boolean
+} & TableXColumn
+
+interface KeyboardTableXProps {
+  /* 通过 id 来确定本单元格内通信，避免多表格时混了。请确保 id 唯一 */
+  id: string
+  columns: KeyboardTableXColumn[]
+  /** 按下键是否允许增加一行数据 */
+  allowAddRowOnDownKey?: boolean
+  /* 增加一行数据 */
+  onAddRow(): void
+  onBeforeDispatch?(options: {
+    actionName: string
+    to: { rowKey: number; columnKey: string }
+    from: { rowKey: number; columnKey: string }
+  }): boolean
+}
+
+type KeyboardDirection = 'left' | 'right' | 'up' | 'down'
+interface KeyboardCustomEvent {
+  cellKey: string
+  direction: KeyboardDirection
+}
+
+interface KeyboardWrapData {
+  id: string
+  fixedWidths: {
+    leftFixedWidth: number
+    rightFixedWidth: number
+  }
+}
+
+interface KeyboardCellProps {
+  /** wrap 传过来的数据 */
+  wrapData: KeyboardWrapData
+  /** Cell 的身份标志，让 Wrap 更方便找到 */
+  cellKey: string
+  /** Wrap 要 focus 到单元格的时候触发 onFocus，请实现此功能 */
+  onFocus(): void
+  /** 表格多的时候需要滚到视窗 */
+  onScroll(data: KeyboardWrapData['fixedWidths']): void
+  /** 是否具有响应能力 */
+  disabled?: boolean
+}
+
+interface WrapProps {
+  /** 通过 id 来确定本单元格内通信，避免多表格时混了，请确保 id 唯一 */
+  id: string
+  /** 增加一行数据 */
+  onAddRow(): void
+  onBeforeDispatch?(options: {
+    actionName: string
+    to: { rowKey: number; columnKey: string }
+    from: { rowKey: number; columnKey: string }
+  }): boolean
+
+  /** 按下键是否允许增加一行数据 */
+  allowAddRowOnDownKey?: boolean
+
+  /** Wrap 需要知道字段集合，以便能找到相应的单元格，请确保表格的顺序一致 */
+  columnKeys: string[]
+  /** Wrap 需要知道有多少行，以便能找到相应的单元格，同时必要时会触发 onAddRow，告知调用方需要增加一行数据 */
+  dataLength: number
+  fixedWidths: {
+    leftFixedWidth: number
+    rightFixedWidth: number
+  }
+}
+
+type MoreSelectRef = {
+  /**  默认搜索 */
+  handleInitSearch: (q?: string) => void
+}
+
+export type {
+  KeyboardCellProps,
+  WrapProps,
+  KeyboardTableXProps,
+  KeyboardTableXColumn,
+  KeyboardCustomEvent,
+  KeyboardDirection,
+  KeyboardWrapData,
+  MoreSelectRef,
+}

package/src/utils/constant.ts

@@ -1,21 +1,21 @@
-const KEYBOARD_ONFOCUS = 'KEYBOARD_ONFOCUS_'
-const KEYBOARD_DIRECTION = 'KEYBOARD_DIRECTION_'
-const KEYBOARD_ENTER = 'KEYBOARD_ENTER_'
-const KEYBOARD_TAB = 'KEYBOARD_TAB_'
-
-const KeyboardActionsName = {
-  ENTER: 'enter',
-  TAB: 'tab',
-  UP: 'up',
-  DOWN: 'down',
-  LEFT: 'left',
-  RIGHT: 'right',
-}
-
-export {
-  KEYBOARD_ONFOCUS,
-  KeyboardActionsName,
-  KEYBOARD_DIRECTION,
-  KEYBOARD_TAB,
-  KEYBOARD_ENTER,
-}
+const KEYBOARD_ONFOCUS = 'KEYBOARD_ONFOCUS_'
+const KEYBOARD_DIRECTION = 'KEYBOARD_DIRECTION_'
+const KEYBOARD_ENTER = 'KEYBOARD_ENTER_'
+const KEYBOARD_TAB = 'KEYBOARD_TAB_'
+
+const KeyboardActionsName = {
+  ENTER: 'enter',
+  TAB: 'tab',
+  UP: 'up',
+  DOWN: 'down',
+  LEFT: 'left',
+  RIGHT: 'right',
+}
+
+export {
+  KEYBOARD_ONFOCUS,
+  KeyboardActionsName,
+  KEYBOARD_DIRECTION,
+  KEYBOARD_TAB,
+  KEYBOARD_ENTER,
+}

package/src/utils/context.ts

@@ -1,4 +1,4 @@
-import { createContext } from 'react'
-
-export const CellKeyContext = createContext<string>('')
-export const WrapContext = createContext<string>('')
+import { createContext } from 'react'
+
+export const CellKeyContext = createContext<string>('')
+export const WrapContext = createContext<string>('')

package/src/utils/do_focus.ts

@@ -1,14 +1,14 @@
-import { KEYBOARD_ONFOCUS } from './constant'
-import { KeyboardCustomEvent } from '../types'
-
-function doFocus(id: string, rowKey: number, columnKey: string) {
-  window.dispatchEvent(
-    new CustomEvent<Pick<KeyboardCustomEvent, 'cellKey'>>(`${KEYBOARD_ONFOCUS}${id}`, {
-      detail: {
-        cellKey: `${rowKey}_${columnKey}`,
-      },
-    })
-  )
-}
-
-export default doFocus
+import { KEYBOARD_ONFOCUS } from './constant'
+import { KeyboardCustomEvent } from '../types'
+
+function doFocus(id: string, rowKey: number, columnKey: string) {
+  window.dispatchEvent(
+    new CustomEvent<Pick<KeyboardCustomEvent, 'cellKey'>>(`${KEYBOARD_ONFOCUS}${id}`, {
+      detail: {
+        cellKey: `${rowKey}_${columnKey}`,
+      },
+    })
+  )
+}
+
+export default doFocus

package/src/utils/get_column_key.ts

@@ -1,11 +1,11 @@
-import _ from 'lodash'
-import { KeyboardTableXColumn } from '../types'
-
-function getColumnKey(column: KeyboardTableXColumn) {
-  if (_.isString(column.accessor)) return column.accessor
-  else if (_.isFunction(column.accessor) && column.id) return column.id
-  else if (column.id) return column.id
-  return null
-}
-
-export default getColumnKey
+import _ from 'lodash'
+import { KeyboardTableXColumn } from '../types'
+
+function getColumnKey(column: KeyboardTableXColumn) {
+  if (_.isString(column.accessor)) return column.accessor
+  else if (_.isFunction(column.accessor) && column.id) return column.id
+  else if (column.id) return column.id
+  return null
+}
+
+export default getColumnKey

package/src/utils/get_key.ts

@@ -1,8 +1,8 @@
-function getKey(cellKey: string) {
-  const index = cellKey.indexOf('_')
-  const rowKey = parseInt(cellKey.slice(0, index), 10)
-  const columnKey = cellKey.slice(index + 1)
-  return { rowKey, columnKey }
-}
-
-export default getKey
+function getKey(cellKey: string) {
+  const index = cellKey.indexOf('_')
+  const rowKey = parseInt(cellKey.slice(0, index), 10)
+  const columnKey = cellKey.slice(index + 1)
+  return { rowKey, columnKey }
+}
+
+export default getKey

package/src/utils/index.ts

@@ -1,8 +1,8 @@
-export { default as getColumnKey } from './get_column_key'
-export * from './context'
-export * from './constant'
-export { default as getKey } from './get_key'
-export { default as doFocus } from './do_focus'
-export { default as useContextData } from './use_context_data'
-export { default as isInputUnBoundary } from './is_input_un_boundary'
-export { default as scrollIntoViewFixedWidth } from './scroll_into_view_fixed_width'
+export { default as getColumnKey } from './get_column_key'
+export * from './context'
+export * from './constant'
+export { default as getKey } from './get_key'
+export { default as doFocus } from './do_focus'
+export { default as useContextData } from './use_context_data'
+export { default as isInputUnBoundary } from './is_input_un_boundary'
+export { default as scrollIntoViewFixedWidth } from './scroll_into_view_fixed_width'

package/src/utils/is_input_un_boundary.ts

@@ -1,29 +1,29 @@
-import { KeyboardEvent } from 'react'
-
-function is_input_un_boundary(event: KeyboardEvent<HTMLElement>): boolean {
-  const { key, target } = event
-  const {
-    tagName,
-    type,
-    selectionStart,
-    selectionEnd,
-    value,
-  } = target as HTMLInputElement
-
-  if (
-    tagName === 'INPUT' &&
-    type === 'text' &&
-    (key === 'ArrowLeft' || key === 'ArrowRight')
-  ) {
-    // 有选择文本
-    if (selectionStart !== selectionEnd) return true
-    else if (event.key === 'ArrowLeft') {
-      if (selectionStart !== 0) return true
-    } else if (event.key === 'ArrowRight') {
-      if (selectionEnd !== value.length) return true
-    }
-  }
-  return false
-}
-
-export default is_input_un_boundary
+import { KeyboardEvent } from 'react'
+
+function is_input_un_boundary(event: KeyboardEvent<HTMLElement>): boolean {
+  const { key, target } = event
+  const {
+    tagName,
+    type,
+    selectionStart,
+    selectionEnd,
+    value,
+  } = target as HTMLInputElement
+
+  if (
+    tagName === 'INPUT' &&
+    type === 'text' &&
+    (key === 'ArrowLeft' || key === 'ArrowRight')
+  ) {
+    // 有选择文本
+    if (selectionStart !== selectionEnd) return true
+    else if (event.key === 'ArrowLeft') {
+      if (selectionStart !== 0) return true
+    } else if (event.key === 'ArrowRight') {
+      if (selectionEnd !== value.length) return true
+    }
+  }
+  return false
+}
+
+export default is_input_un_boundary

package/src/utils/scroll_into_view_fixed_width.ts

@@ -1,71 +1,71 @@
-import { TableXUtil } from '@gm-pc/table-x'
-
-import { KeyboardWrapData } from '../types'
-const { TABLE_X } = TableXUtil
-
-function scrollIntoViewFixedWidth(
-  dom: HTMLElement,
-  fixedWidth: KeyboardWrapData['fixedWidths']
-) {
-  const td = getTd(dom)
-  if (!td) return
-
-  const table = getTable(dom)
-  if (!table) return
-
-  const tableRect = table.getBoundingClientRect()
-  const tdRect = td.getBoundingClientRect()
-
-  const { leftFixedWidth, rightFixedWidth } = fixedWidth
-  const { scrollLeft } = table
-  const { offsetLeft, offsetWidth } = td
-
-  if (offsetLeft - leftFixedWidth < scrollLeft) {
-    table.scrollLeft = offsetLeft - leftFixedWidth
-  } else if (
-    offsetLeft + offsetWidth - (table.offsetWidth - rightFixedWidth) >
-    scrollLeft
-  ) {
-    table.scrollLeft = offsetLeft + offsetWidth - (table.offsetWidth - rightFixedWidth)
-  }
-
-  // 只 tablex 生效
-  if (table.classList.contains('gm-table-x-virtualized')) {
-    // 如果被遮挡
-    if (tdRect.top - tableRect.top < TABLE_X.HEIGHT_HEAD_TR) {
-      // 则滚一个 tr 距离
-      table.scrollTop = table.scrollTop - TABLE_X.HEIGHT_TR
-    }
-  }
-}
-
-export default scrollIntoViewFixedWidth
-
-function getTd(dom: HTMLElement) {
-  let parentNode = dom?.parentNode as HTMLElement
-  while (
-    !(
-      parentNode.classList.contains('rt-td') ||
-      parentNode.classList.contains('gm-table-x-td')
-    )
-  ) {
-    parentNode = parentNode.parentNode as HTMLElement
-    if (parentNode === document.body) return null
-  }
-
-  return parentNode
-}
-
-function getTable(dom: HTMLElement) {
-  let parentNode = dom?.parentNode as HTMLElement
-  while (
-    !(
-      parentNode.classList.contains('gm-table-x') ||
-      parentNode.classList.contains('gm-table-x-virtualized')
-    )
-  ) {
-    parentNode = parentNode.parentNode as HTMLElement
-    if (parentNode === document.body) return null
-  }
-  return parentNode
-}
+import { TableXUtil } from '@gm-pc/table-x'
+
+import { KeyboardWrapData } from '../types'
+const { TABLE_X } = TableXUtil
+
+function scrollIntoViewFixedWidth(
+  dom: HTMLElement,
+  fixedWidth: KeyboardWrapData['fixedWidths']
+) {
+  const td = getTd(dom)
+  if (!td) return
+
+  const table = getTable(dom)
+  if (!table) return
+
+  const tableRect = table.getBoundingClientRect()
+  const tdRect = td.getBoundingClientRect()
+
+  const { leftFixedWidth, rightFixedWidth } = fixedWidth
+  const { scrollLeft } = table
+  const { offsetLeft, offsetWidth } = td
+
+  if (offsetLeft - leftFixedWidth < scrollLeft) {
+    table.scrollLeft = offsetLeft - leftFixedWidth
+  } else if (
+    offsetLeft + offsetWidth - (table.offsetWidth - rightFixedWidth) >
+    scrollLeft
+  ) {
+    table.scrollLeft = offsetLeft + offsetWidth - (table.offsetWidth - rightFixedWidth)
+  }
+
+  // 只 tablex 生效
+  if (table.classList.contains('gm-table-x-virtualized')) {
+    // 如果被遮挡
+    if (tdRect.top - tableRect.top < TABLE_X.HEIGHT_HEAD_TR) {
+      // 则滚一个 tr 距离
+      table.scrollTop = table.scrollTop - TABLE_X.HEIGHT_TR
+    }
+  }
+}
+
+export default scrollIntoViewFixedWidth
+
+function getTd(dom: HTMLElement) {
+  let parentNode = dom?.parentNode as HTMLElement
+  while (
+    !(
+      parentNode.classList.contains('rt-td') ||
+      parentNode.classList.contains('gm-table-x-td')
+    )
+  ) {
+    parentNode = parentNode.parentNode as HTMLElement
+    if (parentNode === document.body) return null
+  }
+
+  return parentNode
+}
+
+function getTable(dom: HTMLElement) {
+  let parentNode = dom?.parentNode as HTMLElement
+  while (
+    !(
+      parentNode.classList.contains('gm-table-x') ||
+      parentNode.classList.contains('gm-table-x-virtualized')
+    )
+  ) {
+    parentNode = parentNode.parentNode as HTMLElement
+    if (parentNode === document.body) return null
+  }
+  return parentNode
+}

package/src/utils/use_context_data.ts

@@ -1,12 +1,12 @@
-import { useContext } from 'react'
-import { WrapContext, CellKeyContext } from './context'
-import { KeyboardWrapData } from '../types'
-
-function useContextData() {
-  const wrapData: KeyboardWrapData = JSON.parse(useContext(WrapContext))
-  const cellKey = useContext(CellKeyContext)
-
-  return { wrapData, cellKey }
-}
-
-export default useContextData
+import { useContext } from 'react'
+import { WrapContext, CellKeyContext } from './context'
+import { KeyboardWrapData } from '../types'
+
+function useContextData() {
+  const wrapData: KeyboardWrapData = JSON.parse(useContext(WrapContext))
+  const cellKey = useContext(CellKeyContext)
+
+  return { wrapData, cellKey }
+}
+
+export default useContextData