Create, run and share your code directly from Office
Clone or download
Permalink
Failed to load latest commit information.
.github Update dogfood instructions [skip ci] May 7, 2018
.vscode Custom functions preview refresh (#866) Sep 19, 2018
config Add ability to switch to reactalpha/reactbeta sites Sep 20, 2018
manifests Update manifests Sep 18, 2018
src Merge branch 'fix-key-warning' Sep 20, 2018
store_metadata Translation to German for the meta data for the store (#501) Jul 13, 2017
test_cases/custom_functions Custom function support (#769) Mar 31, 2018
.codacy.yml Custom functions metadata parser (#767) Apr 3, 2018
.gitignore Custom functions metadata parser (#767) Apr 3, 2018
.nmvrc adding travis build definition Feb 21, 2017
.prettierrc Convert function names to UPPERCASE, add internal debugging May 6, 2018
.travis.yml Update .travis.yml (#610) Sep 8, 2017
CONTRIBUTING.md Update CONTRIBUTING.md Jun 19, 2018
CUSTOM.FUNCTIONS.DOGFOOD.md Update CUSTOM.FUNCTIONS.DOGFOOD.md Jun 6, 2018
LICENSE LICENSE was missing two words at the end for some reason Apr 14, 2017
README.md Prettier Formatting (#822) May 23, 2018
TESTING.md added ribbon manual test cases Nov 21, 2017
TRANSLATING.md Fix Outlook Manifests (#571) Aug 18, 2017
jest.config.js fix (#771) Apr 4, 2018
package-lock.json Add more thorough check for Custom Functions support May 4, 2018
package.json Use @types/custom-functions-runtime Sep 20, 2018
tsconfig.json Nicobell/custom functions improvement (#798) Apr 30, 2018
tsconfig.server.json Nicobell/custom functions improvement (#798) Apr 30, 2018
tsconfig.webpack.json Nicobell/custom functions improvement (#798) Apr 30, 2018
tslint.json Prettier Formatting (#822) May 23, 2018
yarn.lock Use @types/custom-functions-runtime Sep 20, 2018

README.md

Build Status code style: prettier

Script Lab, a Microsoft Garage project

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:

  • Code in a pane beside your spreadsheet. IntelliSense is there while you type so you can easily discover and use the Office JavaScript objects and methods. And if you don't want to start from scratch there are plenty of samples pre-installed with Script Lab. Your snippets can use any TypeScript features like arrow functions, template strings, and async/await (i.e., a good chunk of ES6 and ES7 features). But it's not only script: your snippets can also use HTML, CSS, and references to external libraries and data on the web. Script Lab uses the Monaco editor, the same tech that powers VS Code, so it's beautiful and lightweight.
  • Run the code in another pane beside the edlitor. Execution can include logic, API calls to Office, UI in the pane, and even output to a console. Every time you make a code change you can refresh the editor and run the new version in seconds.
  • Share your snippets through GitHub. If you create a snippet you'd like to share, you can use Script Lab to save it. Then send the link to someone else to try it and tweak it on their computer. The Import feature lets you load other people's snippets.

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:

  • To Code, select the INSERT tab and choose My Add-ins, then insert Script Lab.
  • To Run a snippet, click the small Run triangle icon at the top of the Script Lab code pane.

Stay up-to-date

Contribute to Script Lab

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

  • File bugs & suggestions (see more in "Report a bug, or suggest a feature" above).
  • Contribute new samples, or improve existing one. Please submit a pull request to the office-js-snippets repo; more info in the README of that repo.
  • Spread the word! Whether through writing a blog post (README.md#external-posts), recording a video, tweeting about us, or sharing snippets with colleagues or the StackOverflow community -- we want more of the world to use Script Lab!
  • Help improve the documentation. If you feel like this README or the CONTRIBUTING.md doc could use more details, please send a pull request!

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.