Socket
Socket
Sign inDemoInstall

@ampproject/amp-instagram

Package Overview
Dependencies
2
Maintainers
16
Versions
94
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ampproject/amp-instagram

AMP HTML amp-instagram Component


Version published
Maintainers
16
Created

Readme

Source

Bento Instagram

Usage

The Bento Instagram component allows you embed an Instagram post. It can be used as a web component <bento-instagram>, or as a Preact/React functional component <BentoInstagram>.

Web Component

You must include each Bento component's required CSS library before adding custom styles in order to guarantee proper loading. Or use the lightweight pre-uprgrade styles available inline. See Layout and Style.

The examples below demonstrate use of the <bento-instagram> web component.

Example: Import via npm

[example preview="top-frame" playground="false"]

Install via npm:

npm install @ampproject/bento-instagram
import '@ampproject/bento-instagram';

[/example]

Example: Include via <script>

[example preview="top-frame" playground="false"]

<head>
  <script async custom-element="bento-instagram" src="https://cdn.ampproject.org/v0/bento-instagram-1.0.js"></script>
  <style data-bento-boilerplate>
    bento-instagram {
      display: block;
      overflow: hidden;
      position: relative;
    }
  </style>
</head>
<bento-instagram
  id="my-instagram"
  data-shortcode="CKXYAzuj7TE"
  data-captioned>
</bento-instagram>
<button id="change-shortcode">Change shortcode</button>
</div>

<script>
  (async () => {
    const instagram = document.querySelector('#my-instagram');
    await customElements.whenDefined('bento-instagram');

    // set up button actions
    document.querySelector('#change-shortcode').onclick = () => instagram.dataset.shortcode = '1totVhIFXl';
  })();
</script>

[/example]

Layout and style

Each Bento component has a small CSS library you must include to guarantee proper loading without content shifts. Because of order-based specificity, you must manually ensure that stylesheets are included before any custom styles.

<link rel="stylesheet" type="text/css" href="https://cdn.ampproject.org/v0/bento-instagram-1.0.css">

Alternatively, you may also make the light-weight pre-upgrade styles available inline:

<style data-bento-boilerplate>
  bento-instagram {
    display: block;
    overflow: hidden;
    position: relative;
  }
</style>

Container type

The bento-instagram component has a defined layout size type. To ensure the component renders correctly, be sure to apply a size to the component and its immediate children (slides) via a desired CSS layout (such as one defined with height, width, aspect-ratio, or other such properties):

bento-instagram {
  height: 500px;
  width: 100px;
}
Attributes
data-shortcode

The instagram data-shortcode is found in every instagram photo URL. For example, in https://instagram.com/p/fBwFP, fBwFP is the data-shortcode.

data-captioned

Include the Instagram caption. bento-instagram will attempt to resize to the correct height including the caption.

Styling

You may use the bento-instagram element selector to style the component.

Preact/React Component

The examples below demonstrates use of the <BentoInstagram> as a functional component usable with the Preact or React libraries.

Example: Import via npm

[example preview="top-frame" playground="false"]

Install via npm:

npm install @ampproject/bento-instagram
import React from 'react';
import { BentoInstagram } from '@ampproject/bento-instagram/react';
import '@ampproject/bento-instagram/styles.css';
function App() {
  return (
    <BentoInstagram
      shortcode="CKXYAzuj7TE"
      captioned
    />
  );
}

[/example]

Layout and style

Container type

The BentoInstagram component has a defined layout size type. To ensure the component renders correctly, be sure to apply a size to the component and its immediate children (slides) via a desired CSS layout (such as one defined with height, width, aspect-ratio, or other such properties). These can be applied inline:

<BentoInstagram style={{width: '300px', height: '200px'}} shortcode="CKXYAzuj7TE">
</BentoInstagram>

Or via className:

<BentoInstagram className='custom-styles' shortcode="CKXYAzuj7TE">
</BentoInstagram>
.custom-styles {
  height: 100px;
  width: 100%;
}
Props
shortcode

The instagram shortcode is found in every instagram photo URL. For example, in https://instagram.com/p/fBwFP, fBwFP is the shortcode.

captioned

Include the Instagram caption. bento-instagram will attempt to resize to the correct height including the caption.

FAQs

Last updated on 14 Oct 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc