Skip to content
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.

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

docs[okta-vue]: fix misspelled reference in composition api example #146

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

Conversation

lqbach
Copy link

@lqbach lqbach commented Nov 1, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Adding Tests
  • Build related changes
  • CI related changes
  • Documentation changes
  • Other... Please describe:

What is the current behavior?

In the example for showing Login and Logout buttons in the documentation, the composition API example mistakenly references auth as $auth:

<script setup lang="ts">
import { useAuth } from '@okta/okta-vue';

const $auth = useAuth();

const login = async () => {
  await auth.signInWithRedirect()
}

const logout = async () => {
  await auth.signOut()
}
</script>

References prefixed with a $ is typically used to depict properties that are globally available in the application, as stated in Vue 2 documentation:

$ is a convention Vue uses for properties that are available to all instances [source: Instance Properties in Vue]

The variable auth is also undefined in the example as the composable is set to the variable $auth.

What is the new behavior?

Change the reference from $auth to auth so that the reference is accurate and compliant with Vue conventions.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant