Skip to content

@i18n-micro/devtools-ui

25 exports across 4 entry points. Generated from the API snapshot that pnpm run api:surface checks against the TypeScript sources.

@i18n-micro/devtools-ui

ts
import { /* … */ } from '@i18n-micro/devtools-ui'
ExportKindSignature
BridgeAdapterinterface6 members
createBridgefunction(options: CreateBridgeOptions) => I18nDevToolsBridge
CreateBridgeOptionsinterface4 members
createRpcClientfunction() => I18nDevToolsBridge
I18nDevToolsBridgeinterface4 members
I18nDevToolsElementconstimport("vue/dist/vue").VueElementConstructor<any>
JsonRpcEventinterface3 members
JsonRpcRequestinterface4 members
JsonRpcResponseinterface4 members
JSONValuetypestring | null | number | boolean | { [key: string]: JSONValue }
LocaleDatatypeRecord<string, TranslationContent>
registerfunction() => void
setupRpcHostfunction(iframeWindow: Window, bridge: I18nDevToolsBridge) => () => void
TranslationContentinterface1 members
TreeNodeinterface4 members
BridgeAdapter — 6 members
MemberType
addRouteTranslations(locale: string, routeName: string, content: TranslationContent, merge: boolean) => void
addTranslations(locale: string, content: TranslationContent, merge: boolean) => void
getCurrentLocale?(() => string) | undefined
getFallbackLocale?(() => string) | undefined
getRouteCache() => Record<string, TranslationContent>
subscribe(callback: () => void) => () => void
CreateBridgeOptions — 4 members
MemberType
adapterBridgeAdapter
defaultLocale?string | undefined
locales?Locale[] | undefined
translationDir?string | undefined
I18nDevToolsBridge — 4 members
MemberType
getConfigs() => Promise<ModuleOptions>
getLocalesAndTranslations() => Promise<LocaleData>
onLocalesUpdate(callback: (data: LocaleData) => void) => () => void
saveTranslation(filePath: string, content: TranslationContent) => Promise<void>
JsonRpcEvent — 3 members
MemberType
jsonrpc"2.0"
methodstring
params?unknown
JsonRpcRequest — 4 members
MemberType
idstring
jsonrpc"2.0"
methodstring
params?unknown
JsonRpcResponse — 4 members
MemberType
error?{ code: number; message: string; data?: unknown; } | undefined
idstring
jsonrpc"2.0"
result?unknown
TranslationContent — 1 members
MemberType
[string]JSONValue
TreeNode — 4 members
MemberType
childrenTreeNode[]
fullPathstring
isFileboolean
namestring
## `@i18n-micro/devtools-ui/bridge`
ts
import { /* … */ } from '@i18n-micro/devtools-ui/bridge'
ExportKindSignature
BRIDGE_INTERFACE_MODULEconsttrue
I18nDevToolsBridgeinterface4 members
JSONValuetypestring | null | number | boolean | { [key: string]: JSONValue }
LocaleDatatypeRecord<string, TranslationContent>
TranslationContentinterface1 members

I18nDevToolsBridge — 4 members, identical to I18nDevToolsBridge above. TranslationContent — 1 members, identical to TranslationContent above.

@i18n-micro/devtools-ui/bridge/create

ts
import { /* … */ } from '@i18n-micro/devtools-ui/bridge/create'
ExportKindSignature
BridgeAdapterinterface6 members
createBridgefunction(options: CreateBridgeOptions) => I18nDevToolsBridge
CreateBridgeOptionsinterface4 members

BridgeAdapter — 6 members, identical to BridgeAdapter above. CreateBridgeOptions — 4 members, identical to CreateBridgeOptions above.

@i18n-micro/devtools-ui/vite

ts
import { /* … */ } from '@i18n-micro/devtools-ui/vite'
ExportKindSignature
DevToolsPluginOptionsinterface3 members
i18nDevToolsPluginfunction(options?: DevToolsPluginOptions) => PluginOption
DevToolsPluginOptions — 3 members
MemberType
base?string | undefined
injectButton?boolean | undefined
translationDir?string | undefined

Back to all packages · Integration guides

Released under the MIT License.