# Embr Periscope Module [<img src="https://cdn.mussonindustrial.com/files/public/images/emblem.svg" alt="Musson Industrial Logo" width="90" height="40" align="right">][embr]

[![Build](https://github.com/mussonindustrial/embr/actions/workflows/build.yml/badge.svg)]()
[![version](https://img.shields.io/github/v/release/mussonindustrial/embr?filter=*periscope*&label=Latest)](CHANGELOG.md)
[![Ignition](https://img.shields.io/badge/Ignition-8.1.33+-rebeccapurple.svg)](https://inductiveautomation.com/)
[![Documentation](https://img.shields.io/badge/Documentation-docs.mussonindustrial.com-white.svg?logo=docusaurus)](https://docs.mussonindustrial.com/ignition/embr-periscope)

<div style="border-left: 4px solid #4CAF50; padding: 10px; font-family: Arial, sans-serif;">
<h3 style="color: #red; margin-top: 0;">Periscope</h3>
  <p><em>A periscope provides a new perspective</em> by allowing users to see over, around, or through obstacles, offering a unique view otherwise obstructed.</p>
</div>

A module for Ignition that includes design extensions and enhancements for Perspective.

## Getting Started

1. Download the [latest version] from [releases].
2. Install the module through the Ignition Gateway web interface.

### Module Documentation

- [Module documentation] is available at [docs.mussonindustrial.com].

### Component Directory

| Name                                                                                                        | Category    | Description                                                                                                                                                           |
| ----------------------------------------------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Embedded View +](https://docs.mussonindustrial.com/ignition/embr-periscope/components/embedded-view-plus/) | Embedding + | An enhanced Embedded View component with load ahead optimizations and gateway-side property handling.                                                                 |
| [Flex Repeater +](https://docs.mussonindustrial.com/ignition/embr-periscope/components/flex-repeater-plus/) | Embedding + | An enhanced Flex Repeater component with support for unique view paths, common view parameters/styling, load ahead optimizations, and gateway-side property handling. |
| [Swiper](https://docs.mussonindustrial.com/ignition/embr-periscope/components/swiper/)                      | Embedding + | Swiper is the most modern free and open source mobile touch slider with hardware accelerated transitions and amazing native behavior.                                 |

### Scripting Directory

| Name                                                                                                                                                                   | Category    | Description                                                 |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ----------------------------------------------------------- |
| [`system.perspective.runJavaScriptAsync`](https://docs.mussonindustrial.com/ignition/embr-periscope/scripting/perspective/system-perspective-runJavaScriptAsync)       | Perspective | Asynchronously run JavaScript code on the client.           |
| [`system.perspective.runJavaScriptBlocking`](https://docs.mussonindustrial.com/ignition/embr-periscope/scripting/perspective/system-perspective-runJavaScriptBlocking) | Perspective | Run JavaScript code on the client and block for the result. |

## Changelog

The [changelog](./CHANGELOG.md) is regularly updated to reflect what's changed in each new release.

## Sponsors

Maintenance of this project is made possible by all the [contributors] and [sponsors].
If you'd like to sponsor this project and have your avatar or company logo appear below [click here](https://github.com/sponsors/mussonindustrial). 💖

[embr]: https://github.com/mussonindustrial/embr
[releases]: https://github.com/mussonindustrial/embr/releases
[docs.mussonindustrial.com]: https://docs.mussonindustrial.com
[Module documentation]: https://docs.mussonindustrial.com/ignition/embr-periscope
[contributors]: https://github.com/JamesIves/github-pages-deploy-action/graphs/contributors
[sponsors]: https://github.com/sponsors/mussonindustrial
[latest version]: https://github.com/mussonindustrial/embr/releases?q=periscope&expanded=true