@creekjs/web-components 1.0.0

package/README.md

@@ -0,0 +1,1026 @@
+# @creekjs/web-components
+
+No description available
+
+## Installation
+
+```bash
+npm install @creekjs/web-components
+# or
+yarn add @creekjs/web-components
+# or
+pnpm add @creekjs/web-components
+```
+
+## Usage
+
+```typescript
+import { /* component names */ } from '@creekjs/web-components';
+```
+
+## API Reference
+
+
+### BgCenterProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| children | `React.ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/bg-center/index.tsx`
+
+---
+
+
+### BgCenter
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| children | `React.ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/bg-center/index.tsx`
+
+---
+
+
+### CreekConfigContextProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| iconFontCNs | `string[]` |  |
+
+
+
+
+**Source:** `web-components/src/creek-config-provider/CreekConfigContext.tsx`
+
+---
+
+
+### CreekConfigContext
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| iconFontCNs | `string[]` |  |
+
+
+
+
+**Source:** `web-components/src/creek-config-provider/CreekConfigContext.tsx`
+
+---
+
+
+### CreekConfigProviderProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| children | `React.ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/creek-config-provider/index.tsx`
+
+---
+
+
+### CreekConfigProvider
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| children | `React.ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/creek-config-provider/index.tsx`
+
+---
+
+
+### useViewportHeight
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-hooks/useViewportHeight.tsx`
+
+---
+
+
+### CreekIconProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| iconFontCNs | `CreekConfigProviderProps['iconFontCNs']` |  |
+| type | `string` |  |
+| component | `CustomIconComponentProps['component']` |  |
+
+
+
+
+**Source:** `web-components/src/creek-icon/index.tsx`
+
+---
+
+
+### CreekIcon
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| iconFontCNs | `CreekConfigProviderProps['iconFontCNs']` |  |
+| type | `string` |  |
+| component | `CustomIconComponentProps['component']` |  |
+
+
+
+
+**Source:** `web-components/src/creek-icon/index.tsx`
+
+---
+
+
+### CreekKeepAlive
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-keep-alive/index.tsx`
+
+---
+
+
+### CollapsedButtonProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| collapsed | `boolean` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/CollapseButton.tsx`
+
+---
+
+
+### CollapsedButtonStore
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| collapsed | `boolean` |  |
+| changeCollapsed | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/CollapseButton.tsx`
+
+---
+
+
+### useCollapsedStore
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-layout/CollapseButton.tsx`
+
+---
+
+
+### CollapsedButton
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| collapsed | `boolean` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/CollapseButton.tsx`
+
+---
+
+
+### NotFound
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-layout/Exception/NotFound.tsx`
+
+---
+
+
+### ExceptionProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| children | `React.ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/Exception/index.tsx`
+
+---
+
+
+### Exception
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| children | `React.ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/Exception/index.tsx`
+
+---
+
+
+### FullScreenStore
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| isFullScreen | `boolean` |  |
+| changeFullScreen | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/HeaderContent/FullScreen.tsx`
+
+---
+
+
+### useFullScreenStore
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-layout/HeaderContent/FullScreen.tsx`
+
+---
+
+
+### FullScreen
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| isFullScreen | `boolean` |  |
+| changeFullScreen | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/HeaderContent/FullScreen.tsx`
+
+---
+
+
+### UserInfo
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-layout/HeaderContent/UserInfo.tsx`
+
+---
+
+
+### HeaderContent
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-layout/HeaderContent/index.tsx`
+
+---
+
+
+### LayoutProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| runtimeConfig | `ProLayoutProps` |  |
+| userConfig | `ProLayoutProps` |  |
+| navigate | `(path?: string | number) => void` |  |
+| initialInfo | `{
+    initialState: any` |  |
+| loading | `boolean` |  |
+| setInitialState | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-layout/index.tsx`
+
+---
+
+
+### CreekLayout
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-layout/index.tsx`
+
+---
+
+
+### Loading
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-loading/index.tsx`
+
+---
+
+
+### CreekSearchProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| columns | `ProColumnType<T>[]` |  |
+| onSubmit | `(values: Record<string, any>) => void` |  |
+| justify | `'start' | 'end'` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearch.tsx`
+
+---
+
+
+### CreekSearch
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| columns | `ProColumnType<T>[]` |  |
+| onSubmit | `(values: Record<string, any>) => void` |  |
+| justify | `'start' | 'end'` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearch.tsx`
+
+---
+
+
+### SearchContextValue
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| searchValue | `string` |  |
+| filters | `CreekSearchFilter[]` |  |
+| showValueSelector | `boolean` |  |
+| selectedColumn | `ProColumnType<T, U>` |  |
+| tempValue | `any` |  |
+| inputRef | `React.RefObject<any>` |  |
+| columns | `ProTableProps<T, U, ValueType>['columns']` |  |
+| filterOptions | `ProTableProps<T, U, ValueType>['columns']` |  |
+| onSubmit | `(params: U) => void` |  |
+| beforeSearchSubmit | `(params: Record<string, any>) => Record<string, any>` |  |
+| setSearchValue | `(value: string) => void` |  |
+| setFilters | `React.Dispatch<React.SetStateAction<CreekSearchFilter[]>>` |  |
+| setShowValueSelector | `(show: boolean) => void` |  |
+| setSelectedColumn | `(column: any) => void` |  |
+| setTempValue | `(value: any) => void` |  |
+| handleSearch | `(value: string) => void` |  |
+| handleSelectColumn | `(value: string) => void` |  |
+| addFilter | `(key: string, option: CreekSearchAddFilterOption) => void` |  |
+| confirmAddFilter | `() => void` |  |
+| cancelValueSelector | `() => void` |  |
+| removeFilter | `(filterId: string) => void` |  |
+| handelRest | `() => void` |  |
+| getColumnOptions | `(column: any) => Array<{ label: string` |  |
+| value | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchContext.tsx`
+
+---
+
+
+### useSearchContext
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchContext.tsx`
+
+---
+
+
+### CreekSearchProvider
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| columns | `ProTableProps<T, U, ValueType>['columns']` |  |
+| onSubmit | `(params: U) => void` |  |
+| beforeSearchSubmit | `(params: Record<string, any>) => Record<string, any>` |  |
+| children | `ReactNode` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchContext.tsx`
+
+---
+
+
+### CreekFilterDisplayProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| className | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchFilterDisplay.tsx`
+
+---
+
+
+### CreekFilterDisplay
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| className | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchFilterDisplay.tsx`
+
+---
+
+
+### CreekSearchInputProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| className | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchInput.tsx`
+
+---
+
+
+### CreekSearchInput
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| className | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchInput.tsx`
+
+---
+
+
+### CreekSearchValueSelectorProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| onConfirm | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchValueSelector.tsx`
+
+---
+
+
+### CreekSearchValueSelector
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| onConfirm | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/CreekSearchValueSelector.tsx`
+
+---
+
+
+### CreekSearchAddFilterOption
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| value | `any` |  |
+| displayText | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/type.ts`
+
+---
+
+
+### CreekSearchFilter
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| dataIndex | `string` |  |
+| title | `string` |  |
+
+
+
+
+**Source:** `web-components/src/creek-search/type.ts`
+
+---
+
+
+### SearchProTable
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/SearchTable.tsx`
+
+---
+
+
+### TableOptionRenderProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| defaultDom | `React.ReactNode[]` |  |
+| importConfig | `OptionRenderCustom` |  |
+| exportConfig | `OptionRenderCustom` |  |
+
+
+
+
+**Source:** `web-components/src/creek-table/TableOptionRender.tsx`
+
+---
+
+
+### TableOptionRender
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| defaultDom | `React.ReactNode[]` |  |
+| importConfig | `OptionRenderCustom` |  |
+| exportConfig | `OptionRenderCustom` |  |
+
+
+
+
+**Source:** `web-components/src/creek-table/TableOptionRender.tsx`
+
+---
+
+
+### CreekTableViewRender
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/TableViewContent.tsx`
+
+---
+
+
+### TableViewContent
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/TableViewContent.tsx`
+
+---
+
+
+### useAdaptiveToolBar
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/hooks/useAdaptiveToolBar.tsx`
+
+---
+
+
+### useAutoAddFilterToColumns
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/hooks/useAutoAddFilterToColumns.tsx`
+
+---
+
+
+### useElementDistance
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/hooks/useElementDistance.tsx`
+
+---
+
+
+### CreekTable
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/index.tsx`
+
+---
+
+
+### toolBarRender
+
+No description available
+
+
+
+
+
+
+
+**Source:** `web-components/src/creek-table/toolBarRender.tsx`
+
+---
+
+
+### OptionRenderCustom
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| text | `string` |  |
+| icon | `React.ReactNode` |  |
+| onClick | `() => void` |  |
+
+
+
+
+**Source:** `web-components/src/creek-table/type.ts`
+
+---
+
+
+### CreekTableProps
+
+No description available
+
+
+
+
+#### Properties
+
+| Name | Type | Description |
+|------|------|-------------|
+| pageFixedBottom | `boolean` |  |
+| pageFixedBottomConfig | `{
+    /** 底部保留空间（如固定在底部的元素高度），默认 0 */
+    bottomFix?: number` |  |
+
+
+
+
+**Source:** `web-components/src/creek-table/type.ts`
+
+---
+
+
+## Version
+
+1.0.0
+
+## License
+
+ISC