Skip to content

Fix config type import in docs #219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix config type import in docs #219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs-site/docs/configoptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ sidebar_position: 4

# Config Options

You can use the options below in the `capacitor.config.ts` file under the `electron` prop. Please use `ElectronCapacitorConfig` exported from `@capacitor-community/electron` instead of `CapacitorConfig` from `@capacitor/cli`.\
You can use the options below in the `capacitor.config.ts` file under the `electron` prop. Please use `CapacitorElectronConfig` exported from `@capacitor-community/electron` instead of `CapacitorConfig` from `@capacitor/cli`.\
All options are optional and can be omitted if you do not require them. The `backgroundColor` property will also be used to configure the Electron window color.\
Furthermore, you can edit and tinker with the `electron/src/index.ts` file as more is exposed to the developer as of V3.

```typescript
import { ElectronCapacitorConfig } from '@capacitor-community/electron';
import { CapacitorElectronConfig } from '@capacitor-community/electron';

const config: ElectronCapacitorConfig = {
const config: CapacitorElectronConfig = {
...,
electron: {
// Custom scheme for your app to be served on in the electron window.
Expand All @@ -33,4 +33,4 @@ const config: ElectronCapacitorConfig = {
};

export default config;
```
```