Navigation Back to home

CameraCapture

A camera capture component for taking images directly from an available device camera.

Import
the javascript logo
import { CameraCapture } from "@schukai/monster/source/components/content/camera-capture.mjs";
Source
the git logo
Package
the npm logo
Since
3.111.0

Introduction

The Monster CameraCapture component captures images directly from the device camera. Use it when users should create a photo as part of onboarding, verification or upload workflows.

When to use CameraCapture

  • Use it for direct image capture: ID checks, profile photos and field service documentation are common examples.
  • Use it when immediate capture is better than file picking: The camera flow can be faster and more guided.
  • Do not rely on it as the only upload path: Device permissions and hardware availability can vary.

This is a simple example of a camera capture component.

Javascript

//import '@schukai/monster/source/components/content/camera-capture.mjs';<script type="module">//import '@schukai/monster/source/components/content/camera-capture.mjs';</script>

HTML

<monster-camera-capture>
</monster-camera-capture>

Stylesheet

/** no additional stylesheet is defined **/
Open in playground

Component Design

This component is built using the Shadow DOM, which allows it to encapsulate its internal structure and styling. By using a shadow root, the component's internal elements are isolated from the rest of the webpage, ensuring that external styles or scripts cannot accidentally modify its internal layout or behavior.

Shadow DOM and Accessibility

Since the component is encapsulated within a shadow root, direct access to its internal elements is restricted. This means that developers cannot manipulate or style these elements from outside the component. The Shadow DOM helps maintain consistency in the design and behavior of the component by preventing external interference.

Customizing Through Exported Parts

While the Shadow DOM restricts direct access to the component's internal structure, customization is still possible through exported parts. Specific parts of the component are made accessible for styling by being explicitly marked for export. These exported parts can be targeted and customized using CSS, allowing you to modify the appearance of the component without compromising its encapsulation.

Available Part Attributes

  • control: This part represents the entire control area of the slider, including navigation buttons and thumbnails. Use this to style the general layout a nd background of the control panel.

Below is an example of how to use CSS part attributes to customize different parts of the Control.


monster-component::part(control) {
    background-color: #f0f0f0;
    padding: 10px;
}

Explanation of the Example

  • monster-slider::part(control): Styles the entire control panel, giving it a light background color and some padding.

Accessibility

Accessibility is a key consideration in the design of this component. By following best practices for web accessibility, the component ensures that users of all abilities can interact with it effectively. This includes support for keyboard navigation, screen readers, and other assistive technologies to provide an inclusive user experience.

HTML Structure

<monster-camera-capture></monster-camera-capture>

JavaScript Initialization

const element = document.createElement('monster-camera-capture');
document.body.appendChild(element);

Exported

CameraCapture

Derived from

CustomElement

Options

The Options listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class. Therefore, it inherits Options from these parent classes. If you cannot find a specific Options in this list, we recommend consulting the documentation of the CustomElement.

Option
Type
Default
Description
templates
object
Template definitions
templates.main
string
undefined
Main template
actions
object
undefined
Callbacks
actions.click
string
throw Error
features
object
undefined
Features
features.stripTags
boolean
true
ed text
features.preventOpenEventSent
boolean
false
popper
object
undefined
Popper configuration
popper.placement
string
top
popper.middleware
string[]
["autoPlacement",
r middleware
disabled
boolean
false

  • since
  • deprecated

Properties and Attributes

The Properties and Attributes listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits Properties and Attributes from these parent classes. If you cannot find a specific Properties and Attributes in this list, we recommend consulting the documentation of the CustomElement.

  • data-monster-options: Sets the configuration options for the collapse component when used as an HTML attribute.
  • data-monster-option-[name]: Sets the value of the configuration option [name] for the collapse component when used as an HTML attribute.

Methods

The methods listed in this section are defined directly within the class. This class is derived from several parent classes, including the CustomElement class and ultimately from HTMLElement. Therefore, it inherits methods from these parent classes. If you cannot find a specific method in this list, we recommend consulting the documentation of the CustomElement.

Constructor

constructor()
Constructor for the CameraCapture class. Calls the parent class constructor.

Structural methods

getNextImage()
Retrieve the next image from the queue. If the queue is empty, it returns null.

Static methods

[instanceSymbol]()
Returns
  • {symbol}
This method is called by the instanceof operator.
getCSSStyleSheet()
Returns
  • {CSSStyleSheet[]}
getTag()
Returns
  • {string}

Lifecycle methods

Lifecycle methods are called by the environment and are usually not intended to be called directly.

[assembleMethodSymbol]()
Returns
  • {Components.Content.Copy

Other methods

capture()
Capture an image from the camera and add it to the queue. The image is returned as a data URL.

Events

The component emits the following events:

  • monster-camera-capture-captured

For more information on how to handle events, see the mdn documentation.

The current width of the area is too small to display the content correctly.