Skip to content

Commit eed415a

Browse files
committed
docs: update docs for the 2fa frontend api
AdminForth/1304/plugins-frontend-api.-improve-
1 parent ff0d2ea commit eed415a

2 files changed

Lines changed: 10 additions & 11 deletions

File tree

adminforth/documentation/docs/tutorial/09-Plugins/02-TwoFactorsAuth.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -293,9 +293,9 @@ To do it, first, create frontend custom component which wraps and intercepts cli
293293
</template>
294294

295295
<script setup lang="ts">
296-
import { use2faApi } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
296+
import { useTwoFactorsAuth } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
297297

298-
const { get2FaConfirmationResult } = use2faApi();
298+
const { get2FaConfirmationResult } = useTwoFactorsAuth();
299299
const emit = defineEmits<{ (e: 'callAction', payload?: any): void }>();
300300
const props = defineProps<{ disabled?: boolean; meta?: Record<string, any> }>();
301301

@@ -389,9 +389,9 @@ Frontend (Save Interceptor component injected via pageInjections):
389389
```vue title='/custom/SaveInterceptor.vue'
390390
<script setup>
391391
import { useAdminforth } from '@/adminforth';
392-
import { use2faApi } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
392+
import { useTwoFactorsAuth } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
393393

394-
const { get2FaConfirmationResult } = use2faApi();
394+
const { get2FaConfirmationResult } = useTwoFactorsAuth();
395395
const { registerSaveInterceptor } = useAdminforth();
396396

397397
registerSaveInterceptor(async ({ action, values, resource }) => {
@@ -494,9 +494,9 @@ Imagine you have some button which does some API call
494494

495495
<script setup lang="ts">
496496
import { callApi } from '@/utils';
497-
import { use2faApi } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
497+
import { useTwoFactorsAuth } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
498498

499-
const { get2FaConfirmationResult } = use2faApi();
499+
const { get2FaConfirmationResult } = useTwoFactorsAuth();
500500

501501
async function callAdminAPI() {
502502
const verificationResult = await get2FaConfirmationResult();
@@ -538,9 +538,9 @@ You might want to protect this call with a second factor also. To do it, we need
538538
<script setup lang="ts">
539539
import { callApi } from '@/utils';
540540
import { useAdminforth } from '@/adminforth';
541-
import { use2faApi } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
541+
import { useTwoFactorsAuth } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
542542

543-
const { get2FaConfirmationResult } = use2faApi();
543+
const { get2FaConfirmationResult } = useTwoFactorsAuth();
544544
const { alert } = useAdminforth();
545545

546546
async function callAdminAPI() {

dev-demo/custom/SystemTest.vue

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ const { alert } = useAdminforth();
4141
import adminforth from '@/adminforth';
4242
import { useTwoFactorsAuth } from '@/custom/plugins/TwoFactorsAuthPlugin/use2faApi.ts';
4343
44-
const twoFactorsAuth = useTwoFactorsAuth();
45-
44+
const { get2FaConfirmationResult } = useTwoFactorsAuth();
4645
const valueStart = ref()
4746
4847
watch(valueStart, (newVal) => {
@@ -105,7 +104,7 @@ async function get2FaConfirmationResultWindow() {
105104
}
106105
107106
async function get2FaConfirmationResultTwoFactorsAuth() {
108-
const verificationResult = await twoFactorsAuth.get2FaConfirmationResult(); // this will ask user to enter code
107+
const verificationResult = await get2FaConfirmationResult(); // this will ask user to enter code
109108
console.log('2FA verification result (twoFactorsAuth):', verificationResult);
110109
}
111110
</script>

0 commit comments

Comments
 (0)