Skip to content

Fix mistakes in Vue.js SDK documentation. #704

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

Merged
codedbychavez merged 2 commits into from
Jul 10, 2026
Merged

Fix mistakes in Vue.js SDK documentation. #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e3c1e3d
Fix: wrong pollInterval property.
codedbychavez Jul 10, 2026
3f2adff
Fix: Additional mistakes
codedbychavez Jul 10, 2026
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
10 changes: 5 additions & 5 deletions website/docs/sdk-reference/community/vue.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const VueSchema = require('@site/src/schema-markup/sdk-reference/communit
<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify(VueSchema) }}></script>

:::caution
As this is a community-maintained package, ConfigCat can't guarantee its stability, and safety and can't provide official customer support.
As this is a community-maintained package, ConfigCat can't guarantee its stability and safety, and can't provide official customer support.
:::

<a href="https://github.com/codedbychavez/configcat-vue" target="_blank">ConfigCat SDK for Vue.js on GitHub</a>
Expand Down Expand Up @@ -91,7 +91,7 @@ Optionally, the `FeatureWrapper` component also provides an `#else` and `#loadin

### Specifying a polling mode

Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollingIntervalInSeconds` property.
Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollIntervalSeconds` property.

Import:

Expand All @@ -103,7 +103,7 @@ Add `pollingMode` to the `ConfigCatPlugin` options and set the polling interval

```js
app.use(ConfigCatPlugin, {
sdkKey: "YOUR-CONFIGCAT-SDKKEY-GOES-HERE",
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE",
pollingMode: PollingMode.AutoPoll, // Optional. Default is AutoPoll
clientOptions: {
pollIntervalSeconds: 5 // Optional. Specify the polling interval in seconds. The default is 60 seconds.
Expand All @@ -121,7 +121,7 @@ You may want to log the actions of the underlying ConfigCat SDK client. To do th

> See documentation [here](../js/browser.mdx#logging).

Add `createConsoleLogger`, and `LoggerLevel` to your import:
Add `createConsoleLogger`, and `LogLevel` to your import:

```js
import { createConsoleLogger, LogLevel } from "configcat-vue";
Expand All @@ -135,7 +135,7 @@ Use the logger in `clientOptions`:

```js
app.use(ConfigCatPlugin, {
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // // sdkKey is required
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // sdkKey is required
clientOptions: { // clientOptions is optional
// ...
logger: createConsoleLogger(LogLevel.Info),
Expand Down
10 changes: 5 additions & 5 deletions website/versioned_docs/version-V1/sdk-reference/community/vue.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const VueSchema = require('@site/src/schema-markup/sdk-reference/communit
<script type="application/ld+json" dangerouslySetInnerHTML={{ __html: JSON.stringify(VueSchema) }}></script>

:::caution
As this is a community-maintained package, ConfigCat can't guarantee its stability, and safety and can't provide official customer support.
As this is a community-maintained package, ConfigCat can't guarantee its stability and safety, and can't provide official customer support.
:::

<a href="https://github.com/codedbychavez/configcat-vue" target="_blank">ConfigCat SDK for Vue.js on GitHub</a>
Expand Down Expand Up @@ -91,7 +91,7 @@ Optionally, the `FeatureWrapper` component also provides an `#else` and `#loadin

### Specifying a polling mode

Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollingIntervalInSeconds` property.
Polling modes are used to control how often ConfigCat's SDK client downloads the values of feature flags from ConfigCat's servers. The default polling mode is `AutoPoll`. Auto Polling fetches the latest feature flag values every 60 seconds by default. To change this, Specify a polling mode and set the polling interval (in seconds) via the `pollIntervalSeconds` property.

Import:

Expand All @@ -103,7 +103,7 @@ Add `pollingMode` to the `ConfigCatPlugin` options and set the polling interval

```js
app.use(ConfigCatPlugin, {
sdkKey: "YOUR-CONFIGCAT-SDKKEY-GOES-HERE",
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE",
pollingMode: PollingMode.AutoPoll, // Optional. Default is AutoPoll
clientOptions: {
pollIntervalSeconds: 5 // Optional. Specify the polling interval in seconds. The default is 60 seconds.
Expand All @@ -121,7 +121,7 @@ You may want to log the actions of the underlying ConfigCat SDK client. To do th

> See documentation [here](../js.mdx#logging).

Add `createConsoleLogger`, and `LoggerLevel` to your import:
Add `createConsoleLogger`, and `LogLevel` to your import:

```js
import { createConsoleLogger, LogLevel } from "configcat-vue";
Expand All @@ -135,7 +135,7 @@ Use the logger in `clientOptions`:

```js
app.use(ConfigCatPlugin, {
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // // sdkKey is required
sdkKey: "YOUR-CONFIGCAT-SDK-KEY-GOES-HERE", // sdkKey is required
clientOptions: { // clientOptions is optional
// ...
logger: createConsoleLogger(LogLevel.Info),
Expand Down
Loading