@vue-toolkit/aws-auth

Completely style-able components for Amazon Cognito workflows.

Usage no npm install needed!

<script type="module">
  import vueToolkitAwsAuth from 'https://cdn.skypack.dev/@vue-toolkit/aws-auth';
</script>

README

npm ci

@vue-toolkit/aws-auth

Completely style-able components for Amazon Cognito workflows.

Features

  • 🚀 Vue components with minimal styles
  • 🕵️‍♂️ Amazon Cognito workflows
  • 🔒 Router authentication guards
  • 💪 Written in TypeScript

Installation

npm install --save @vue-toolkit/aws-auth @vue-toolkit/common @aws-amplify/auth

Vue Toolkit requires @vue/composition-api >= v1.1

AWS Auth requires vue-router and @aws-amplify/auth as peer dependencies

Usage

import Vue from 'vue';
import { Auth } from '@aws-amplify/auth';
import Common from '@vue-toolkit/common';
import AwsAuth from '@vue-toolkit/aws-auth';

Auth.configure({
  // your configuration values go here
});

Vue.use(Common);
Vue.use(AwsAuth);

Add routes for authentication components:

import VueRouter, { RouteConfig } from 'vue-router';
import { createAuthRoutes } from '@vue-toolkit/aws-auth';

const router = new VueRouter({
  mode: 'history',
  routes: [
    // your other routes go here
    ...createAuthRoutes(),
  ],
});

Optionally, import the minimal default Sass styles:

@import '@vue-toolkit/aws-auth/sass/components';

Credits

@vue-toolkit/aws-auth is a project by TSG, a full-service digital agency taking software from concept to launch. Our powerhouse team of designers and engineers build iOS, Android, and web apps across many industries.