Skip to content

Fill your HTML templates with data from Google Sheets using the Sheet Best JS lib.

License

Notifications You must be signed in to change notification settings

sheetbest/sheet-best-templates

Repository files navigation

Sheet Best Javascript Template Library

Build Status Coverage Status

Connect Google Sheets to your HTML, through a REST API powered by Sheet Best.

With the Sheet Best JS Template Library you'll be able to:

  • Use SpreadSheet data to display data on your HTML template
  • Insert data from a HTML <form> to a SpreadSheet

Usage

This project requires you to setup a Google Sheet API at Sheet Best. When you get yours get back here (it looks like this: https://sheet.best/api/sheet/cf969697-682a-40e3-bad4-d54803eeeacf). We will use it on the next steps.

Add this snippet to your HTML page:

<script src="https://cdn.sheet.best/sheet-best-templates.min.js"></script>

Then follow the instructions on for the operation that you want to do:

Display Data

To display data you just need to add data-sheet-best attribute to your HTML tag:

<div data-sheet-best="https://sheet.best/api/sheet/cf969697-682a-40e3-bad4-d54803eeeacf"></div>

Then you just need to use {{ }} templates, they will be replaced by the content on your SpreadSheet API

<div data-sheet-best="https://sheet.best/api/sheet/cf969697-682a-40e3-bad4-d54803eeeacf">
  <div>
    <h2>{{ code }}</h2>
    <div>
      <span>Price: <b>{{ price }}</b></span>
      <span>High: <b>{{ high }}</b></span>
      <span>Low: <b>{{ low }}</b></span>
    </div>
  </div>
</div>

A Google Sheet like this:

Will generate a HTML code like this:

<div data-sheet-best="https://sheet.best/api/sheet/cf969697-682a-40e3-bad4-d54803eeeacf">
  <div>
    <h2>COST</h2>
    <div>
      <span>Price: <b>273.59</b></span>
      <span>High: <b>275.36</b></span>
      <span>Low: <b>272.76</b></span>
    </div>
  </div>

  <!-- ...and so on, until... -->

  <div>
    <h2>TSLA</h2>
    <div>
      <span>Price: <b>229.31</b></span>
      <span>High: <b>231.5</b></span>
      <span>Low: <b>228.03</b></span>
    </div>
  </div>
</div>

Inserting Data

To display data you just need to add data-sheet-best attribute to a <form> tag. If your spreadsheet is setup like this:

<form data-sheet-best="https://sheet.best/api/sheet/cf969697-682a-40e3-bad4-d54803eeeacf">
  <input type="text" name="name"/>
  <input type="text" name="email"/>
  <button type="submit">submit</button>
</form>

We will automatically add the information on your SpreadSheet once the user submits the content:

License

The files included in this repository are licensed under the MIT license.

About

Fill your HTML templates with data from Google Sheets using the Sheet Best JS lib.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published