search

OfficeDev / script-lab-2017

[Archived. This is an older version that's no longer maintained. See https://github.com/officedev/script-lab instead]
https://aka.ms/scriptlab
MIT License
218 stars 60 forks source link
code-editor office-addin teaches-people typescript

readme

Build Status code style: prettier

Script Lab 2017, a Microsoft Garage project

IMPORTANT: A newer version of Script Lab, re-built from the ground up using React in late 2018, is now available at https://github.com/officedev/script-lab. This older 2017 version is now mostly for archival purposes. See this link for more info.

Experiment with the Office JavaScript API without ever leaving Excel, Word, or PowerPoint! Get Script Lab for free, from the Office Store.

Topics

What is Script Lab?

Wouldn't it be crazy if you could launch Excel, click to open a small code window, and then instantly start writing and executing JavaScript that interacts with your spreadsheet?

Script lab is a tool for anyone who wants to learn about writing Office add-ins for Excel, Word, or PowerPoint. The focus is the Office JavaScript API, which is the technology you need for building Office Add-ins that run across platforms. Maybe you're an experienced Office developer and you want to quickly prototype a feature for your add-in. Or maybe you've never tried writing code for Office and you just want to play with a sample and tweak it to learn more. Either way, Script Lab is for you. Script Lab has three main features:

You can install Script Lab right now for free from the Office Store! It works for Excel, Word, PowerPoint, and Project. You'll need Office 2013 or later, Office Online, or Office for Mac.

Script Lab is a Microsoft Garage project that began at a hackathon. You can read our story on the Garage website

Here's a 1-minute teaser video to give you a taste:

Script Lab teaser video showing Script Lab being used in Excel to make charts, Word, and Powerpoint Online.

Get Started

The easiest way to try Script Lab is with the Tutorial file for Excel that walks you through the tool in a few steps. You can get it here on GitHub: script-lab-tutorial.xlsx

Alternatively, you can start from scratch and install Script Lab from the Store.

This 10-minute demo explains how to use the main features:

Michael Saunders demos Script Lab

Import someone else's snippet, or export your own

Script Lab is built around sharing. If someone gives you a URL to a GitHub GIST, simply open Script Lab, use the hamburger menu at the top left to see the menu, and choose "Import" category (either on the left or top, depending on the available screen space). Then, enter the URL of the GIST, and click the "Import" button at the bottom of the screen. In just these few clicks, you will be able to view and run someone else's snippet!

Import tab within the "Hamburger" menu showing a text box to import a URL, GitHub gist ID, or snippet YAML

Conversely, to share your snippet with someone, choose the "Share" menu within a particular snippet. You can share as a public or private GitHub Gist, or you can copy the entire snippet metadata to the clipboard, and share it from there.

Share menu with dropdown options: public gist, secret gist, or copy to clipboard

Report a bug, or suggest a feature

To report a bug, create a new issue. Please provide as much detail as you can: tell us the operating system, the Office build number, and your browser (if you're using Office Online).

It can also help to provide your Script Lab User ID (we generate it randomly for each device and it stays assigned to you until you clear your browser cache). You can find this ID under the About section in the editor view:

Inside the 'about' button showing how to find the User ID location

If you have a suggestion for a feature, please feel free to file it under "issues" as well, and we will tag it appropriately. The more detail, the better! We also gladly accept pull requests... (see more at CONTRIBUTING.md).

Finally, if you have a question, please ask it on https://stackoverflow.com instead. Tag your questions with office-js and scriptlab.

Use Script Lab with older Office versions (Office 2013)

Office 2013 has several limitations compared to more recent versions.

First, there are far fewer supported objects and methods in the JavaScript API for Office 2013. As a result, many snippets that work on later versions of Office will not run in Office 2013. In the Samples menu we have included certain samples specifically designed to use only capabilities that are available in Office 2013. Those samples are marked (2013) in the sample title.

Second, Office 2013 (and Office 2016 RTM, if you don't have an Office 365 subscription) does not support ribbon buttons for Script Lab. As a result, there's a different way to access the Code and Run functions:

Stay up-to-date

Contribute to Script Lab

There are a bunch of ways you can contribute to Script Lab:

Finally, if you want to contribute code (bug fixes, features, localization, etc.), please see CONTRIBUTING.md to get you up and running with a local copy of Script Lab -- and then send us a pull request.

Rate and review

Leave a star-rating and (optionally) a review blurb for Script Lab on the Office Store review page.

Of course, we'd prefer that if you have issues you report them on GitHub instead, but you're free to leave any review comments you wish.

Articles & FAQs

External blog posts & media coverage

Meet the Team

Script Lab, a Microsoft Garage project, is brought to you by this fabulous group of well-dressed geeks:

Michael Zlatkovsky, Bhargav Krishna, Jakob Nielsen, Michael Saunders, and Daniel M. Galan.

Meet the Team

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.