Package Exports
- @univerjs/core
- @univerjs/core/index.js
- @univerjs/core/lib/cjs/index.js
- @univerjs/core/lib/es/index.js
- @univerjs/core/lib/types/common/__tests__/array.spec.d.ts
- @univerjs/core/lib/types/common/__tests__/url.spec.d.ts
- @univerjs/core/lib/types/common/array.d.ts
- @univerjs/core/lib/types/common/boolean.d.ts
- @univerjs/core/lib/types/common/const.d.ts
- @univerjs/core/lib/types/common/di.d.ts
- @univerjs/core/lib/types/common/equal.d.ts
- @univerjs/core/lib/types/common/error.d.ts
- @univerjs/core/lib/types/common/function.d.ts
- @univerjs/core/lib/types/common/interceptor.d.ts
- @univerjs/core/lib/types/common/json.d.ts
- @univerjs/core/lib/types/common/memory-cursor.d.ts
- @univerjs/core/lib/types/common/mixin.d.ts
- @univerjs/core/lib/types/common/number.d.ts
- @univerjs/core/lib/types/common/registry.d.ts
- @univerjs/core/lib/types/common/request-immediate-macro-task.d.ts
- @univerjs/core/lib/types/common/sequence.d.ts
- @univerjs/core/lib/types/common/set.d.ts
- @univerjs/core/lib/types/common/shims.d.ts
- @univerjs/core/lib/types/common/unit.d.ts
- @univerjs/core/lib/types/common/url.d.ts
- @univerjs/core/lib/types/docs/data-model/__tests__/replacement.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/document-data-model.d.ts
- @univerjs/core/lib/types/docs/data-model/empty-snapshot.d.ts
- @univerjs/core/lib/types/docs/data-model/index.d.ts
- @univerjs/core/lib/types/docs/data-model/json-x/__tests__/json-x.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/json-x/json-x.d.ts
- @univerjs/core/lib/types/docs/data-model/preset-list-type.d.ts
- @univerjs/core/lib/types/docs/data-model/replacement.d.ts
- @univerjs/core/lib/types/docs/data-model/subdocument.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/action-iterator.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/apply-utils.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/common.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/compose.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/invert.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/text-x.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/transform-position.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/transform.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/__tests__/utils.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/action-iterator.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/action-types.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/apply-utils/common.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/apply-utils/delete-apply.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/apply-utils/insert-apply.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/apply-utils/update-apply.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/apply.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/__test__/custom-range.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/__test__/selection.spec.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/custom-range.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/index.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/parse.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/selection.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/build-utils/text-x-utils.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/text-x.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/transform-utils.d.ts
- @univerjs/core/lib/types/docs/data-model/text-x/utils.d.ts
- @univerjs/core/lib/types/docs/data-model/types.d.ts
- @univerjs/core/lib/types/docs/index.d.ts
- @univerjs/core/lib/types/index.d.ts
- @univerjs/core/lib/types/observer/__tests__/observable.spec.d.ts
- @univerjs/core/lib/types/observer/observable.d.ts
- @univerjs/core/lib/types/services/__tests__/index.d.ts
- @univerjs/core/lib/types/services/__tests__/permission.spec.d.ts
- @univerjs/core/lib/types/services/__tests__/resources.spec.d.ts
- @univerjs/core/lib/types/services/authz-io/authz-io-local.service.d.ts
- @univerjs/core/lib/types/services/authz-io/type.d.ts
- @univerjs/core/lib/types/services/command/__tests__/command.service.spec.d.ts
- @univerjs/core/lib/types/services/command/command.service.d.ts
- @univerjs/core/lib/types/services/config/config.service.d.ts
- @univerjs/core/lib/types/services/context/__tests__/context.service.spec.d.ts
- @univerjs/core/lib/types/services/context/context.d.ts
- @univerjs/core/lib/types/services/context/context.service.d.ts
- @univerjs/core/lib/types/services/error/error.service.d.ts
- @univerjs/core/lib/types/services/instance/instance.service.d.ts
- @univerjs/core/lib/types/services/lifecycle/__tests__/lifecycle.service.spec.d.ts
- @univerjs/core/lib/types/services/lifecycle/lifecycle.d.ts
- @univerjs/core/lib/types/services/lifecycle/lifecycle.service.d.ts
- @univerjs/core/lib/types/services/local-storage/local-storage.service.d.ts
- @univerjs/core/lib/types/services/locale/__tests__/locale.service.spec.d.ts
- @univerjs/core/lib/types/services/locale/locale.service.d.ts
- @univerjs/core/lib/types/services/log/context.d.ts
- @univerjs/core/lib/types/services/log/log.service.d.ts
- @univerjs/core/lib/types/services/permission/permission.service.d.ts
- @univerjs/core/lib/types/services/permission/type.d.ts
- @univerjs/core/lib/types/services/plugin/__tests__/plugin-override.spec.d.ts
- @univerjs/core/lib/types/services/plugin/plugin-override.d.ts
- @univerjs/core/lib/types/services/plugin/plugin.d.ts
- @univerjs/core/lib/types/services/plugin/plugin.service.d.ts
- @univerjs/core/lib/types/services/resource-loader/resource-loader.service.d.ts
- @univerjs/core/lib/types/services/resource-loader/type.d.ts
- @univerjs/core/lib/types/services/resource-manager/resource-manager.service.d.ts
- @univerjs/core/lib/types/services/resource-manager/type.d.ts
- @univerjs/core/lib/types/services/theme/theme.service.d.ts
- @univerjs/core/lib/types/services/undoredo/undoredo.service.d.ts
- @univerjs/core/lib/types/services/user-manager/const.d.ts
- @univerjs/core/lib/types/services/user-manager/user-manager.service.d.ts
- @univerjs/core/lib/types/shared/__tests__/common.spec.d.ts
- @univerjs/core/lib/types/shared/__tests__/name.spec.d.ts
- @univerjs/core/lib/types/shared/__tests__/object-matrix.spec.d.ts
- @univerjs/core/lib/types/shared/__tests__/range.spec.d.ts
- @univerjs/core/lib/types/shared/__tests__/rectangle.spec.d.ts
- @univerjs/core/lib/types/shared/__tests__/ref-alias.spec.d.ts
- @univerjs/core/lib/types/shared/__tests__/rxjs.spec.d.ts
- @univerjs/core/lib/types/shared/after-init-apply.d.ts
- @univerjs/core/lib/types/shared/array-search.d.ts
- @univerjs/core/lib/types/shared/blob.d.ts
- @univerjs/core/lib/types/shared/check-if-move.d.ts
- @univerjs/core/lib/types/shared/clipboard.d.ts
- @univerjs/core/lib/types/shared/coder.d.ts
- @univerjs/core/lib/types/shared/color/color-kit.d.ts
- @univerjs/core/lib/types/shared/color/color.d.ts
- @univerjs/core/lib/types/shared/command-enum.d.ts
- @univerjs/core/lib/types/shared/common.d.ts
- @univerjs/core/lib/types/shared/compare.d.ts
- @univerjs/core/lib/types/shared/doc-tool.d.ts
- @univerjs/core/lib/types/shared/generate.d.ts
- @univerjs/core/lib/types/shared/hash-algorithm.d.ts
- @univerjs/core/lib/types/shared/index.d.ts
- @univerjs/core/lib/types/shared/lifecycle.d.ts
- @univerjs/core/lib/types/shared/locale.d.ts
- @univerjs/core/lib/types/shared/lru/__tests__/lru-map.spec.d.ts
- @univerjs/core/lib/types/shared/lru/lru-map.d.ts
- @univerjs/core/lib/types/shared/name.d.ts
- @univerjs/core/lib/types/shared/numfmt.d.ts
- @univerjs/core/lib/types/shared/object-matrix-query.d.ts
- @univerjs/core/lib/types/shared/object-matrix.d.ts
- @univerjs/core/lib/types/shared/r-tree.d.ts
- @univerjs/core/lib/types/shared/range.d.ts
- @univerjs/core/lib/types/shared/rectangle.d.ts
- @univerjs/core/lib/types/shared/ref-alias.d.ts
- @univerjs/core/lib/types/shared/row-col-iter.d.ts
- @univerjs/core/lib/types/shared/rxjs.d.ts
- @univerjs/core/lib/types/shared/sequence.d.ts
- @univerjs/core/lib/types/shared/shape.d.ts
- @univerjs/core/lib/types/shared/sort-rules.d.ts
- @univerjs/core/lib/types/shared/timer.d.ts
- @univerjs/core/lib/types/shared/tools.d.ts
- @univerjs/core/lib/types/shared/types.d.ts
- @univerjs/core/lib/types/shared/types/numfmt.type.d.ts
- @univerjs/core/lib/types/sheets/__tests__/cell-data.spec.d.ts
- @univerjs/core/lib/types/sheets/__tests__/create-core-test-bed.d.ts
- @univerjs/core/lib/types/sheets/__tests__/ranges.spec.d.ts
- @univerjs/core/lib/types/sheets/__tests__/span-mode.spec.d.ts
- @univerjs/core/lib/types/sheets/__tests__/styles.spec.d.ts
- @univerjs/core/lib/types/sheets/__tests__/workbook.spec.d.ts
- @univerjs/core/lib/types/sheets/__tests__/worksheet.spec.d.ts
- @univerjs/core/lib/types/sheets/column-manager.d.ts
- @univerjs/core/lib/types/sheets/empty-snapshot.d.ts
- @univerjs/core/lib/types/sheets/range.d.ts
- @univerjs/core/lib/types/sheets/row-manager.d.ts
- @univerjs/core/lib/types/sheets/sheet-snapshot-utils.d.ts
- @univerjs/core/lib/types/sheets/span-model.d.ts
- @univerjs/core/lib/types/sheets/styles.d.ts
- @univerjs/core/lib/types/sheets/typedef.d.ts
- @univerjs/core/lib/types/sheets/util.d.ts
- @univerjs/core/lib/types/sheets/view-model.d.ts
- @univerjs/core/lib/types/sheets/workbook.d.ts
- @univerjs/core/lib/types/sheets/worksheet.d.ts
- @univerjs/core/lib/types/slides/slide-model.d.ts
- @univerjs/core/lib/types/types/const/clipboard.d.ts
- @univerjs/core/lib/types/types/const/const.d.ts
- @univerjs/core/lib/types/types/const/extension-names.d.ts
- @univerjs/core/lib/types/types/const/index.d.ts
- @univerjs/core/lib/types/types/const/theme-color-map.d.ts
- @univerjs/core/lib/types/types/enum/auto-fill-series.d.ts
- @univerjs/core/lib/types/types/enum/border-style-types.d.ts
- @univerjs/core/lib/types/types/enum/color-type.d.ts
- @univerjs/core/lib/types/types/enum/common-hide-types.d.ts
- @univerjs/core/lib/types/types/enum/copy-paste-type.d.ts
- @univerjs/core/lib/types/types/enum/data-validation-error-style.d.ts
- @univerjs/core/lib/types/types/enum/data-validation-ime-mode.d.ts
- @univerjs/core/lib/types/types/enum/data-validation-operator.d.ts
- @univerjs/core/lib/types/types/enum/data-validation-render-mode.d.ts
- @univerjs/core/lib/types/types/enum/data-validation-status.d.ts
- @univerjs/core/lib/types/types/enum/data-validation-type.d.ts
- @univerjs/core/lib/types/types/enum/delete-direction.d.ts
- @univerjs/core/lib/types/types/enum/developer-metadata-visibility.d.ts
- @univerjs/core/lib/types/types/enum/dimension.d.ts
- @univerjs/core/lib/types/types/enum/direction.d.ts
- @univerjs/core/lib/types/types/enum/format-type.d.ts
- @univerjs/core/lib/types/types/enum/group-control-toggle-position.d.ts
- @univerjs/core/lib/types/types/enum/index.d.ts
- @univerjs/core/lib/types/types/enum/interpolation-point-type.d.ts
- @univerjs/core/lib/types/types/enum/locale-type.d.ts
- @univerjs/core/lib/types/types/enum/place-holder-type.d.ts
- @univerjs/core/lib/types/types/enum/protection-type.d.ts
- @univerjs/core/lib/types/types/enum/prst-geom-type.d.ts
- @univerjs/core/lib/types/types/enum/relative-date.d.ts
- @univerjs/core/lib/types/types/enum/sheet-types.d.ts
- @univerjs/core/lib/types/types/enum/text-style.d.ts
- @univerjs/core/lib/types/types/enum/theme-color-type.d.ts
- @univerjs/core/lib/types/types/interfaces/i-cell-custom-render.d.ts
- @univerjs/core/lib/types/types/interfaces/i-cell-validation-data.d.ts
- @univerjs/core/lib/types/types/interfaces/i-data-validation.d.ts
- @univerjs/core/lib/types/types/interfaces/i-document-data-interceptor.d.ts
- @univerjs/core/lib/types/types/interfaces/i-document-data.d.ts
- @univerjs/core/lib/types/types/interfaces/i-image-properties.d.ts
- @univerjs/core/lib/types/types/interfaces/i-need-check-disposable.d.ts
- @univerjs/core/lib/types/types/interfaces/i-placeholder.d.ts
- @univerjs/core/lib/types/types/interfaces/i-shape-properties.d.ts
- @univerjs/core/lib/types/types/interfaces/i-slide-data.d.ts
- @univerjs/core/lib/types/types/interfaces/i-style-data.d.ts
- @univerjs/core/lib/types/types/interfaces/index.d.ts
- @univerjs/core/lib/types/univer.d.ts
- @univerjs/core/lib/umd/index.js
Readme
@univerjs/core
Package Overview
| Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
|---|---|---|---|---|---|---|
@univerjs/core |
UniverCore |
❌ | ❌ |
Introduction
@univerjs/core as its name shows, is the core package of Univer, and provides foundational capabilities including:
- Provision of the Univer type, which serves as the entry point for applications and a mounting point for other plugins, as well as the UniverDoc and UniverSheet types for managing different document types
- Basic models for each document type
- Definition or implementation of several fundamental services, such as:
- Permission control
- Command system
- Undo/Redo
- Configuration system
- Logging system
- Context system
- Lifecycle
- Local storage
- Internationalization
- Resource management
For more information about @univerjs/core's API, please refer to the API documentation.
Usage
Installation
# Using npm
npm install @univerjs/core
# Using pnpm
pnpm add @univerjs/coreConfiguration
import { Univer } from '@univerjs/core';
new Univer({
theme: defaultTheme,
locale: LocaleType.EN_US,
locales,
logLevel: LogLevel.VERBOSE,
});Options
| Name | Type | Default | Description |
|---|---|---|---|
| theme | Theme | - | The theme of the application, which is used to control the appearance of the application. |
| locale | LocaleType | LocaleType.ZH_CN |
The locale of the application. The default value is LocaleType.ZH_CN. |
| locales | ILocales | - | The supported locales of the application. By default, the application supports Chinese. |
| logLevel | LogLevel | LogLevel.SILENT |
The log level of the application. |