Skip to content

Vue SDK 2.3.1

Sample Code

The easiest and fastest way to get started with the SDK is to download and try the sample code. We provide full featured samples for different frameworks and platforms for developer to start with:

Download Vue Sample Code


In the above sample codes, the strings __YOUR_USER_ID__ and __YOUR_API_KEY__ should be replaced by your own User ID and API Key repectively. Please contact us to obtain your User ID and API Key.


In your Vue project, install the SDK with the npm install or yarn add commands. For example:

npm install ""
yarn add ""


Please use Webpack as the bundler for your production code. Other web bundling tool such as Vite is not supported yet.

What's new


  • Added prop VisualizationOptions for rendering bounding box or face mesh.


  • Fixed the iOS 17.2 blank camera problem.


  • New features
    • Added more distance condition: TooFar|TooClose.
    • Also return the condition checking result when scanning.
    • Added age estimation.
    • Added new MediaPipe face detector.
    • Added new MediaPipe face mesh detector.
    • Added FaceAPI face detector.
    • Added API to get camera device list.
    • Added preferredCamera prop.
    • Added disableAgeEstimator prop.
  • Bug fixes
    • Fixed wrong camera orientation problem on iPad when switching camera.
    • Optimized model loading times.


  • Fixed the problem that switching camera is not working.


  • Upgraded to use JavaScript SDK 1.1.0.

  • Support Blink Detection. To enable it, set the faceDetectorType to TFMediaPipe and set the maxFaceDetectionFps to at least 15. For example:

    <script lang="ts">
      setup() {
        return { 
          faceDetectorType: FaceDetectorType.TFMediaPipe
  • Removed FPS debug log.

  • Fixed the problem that a extra instance of VitalSignEngine is created, causing a 403 forbidden error.


  • Rewritten based on new JavaScript SDK.
  • Added PresetFormat prop for setting camera resolution.