Open edX XBlock API Guide

This document provides reference information on the XBlock API. You use this API to build XBlocks.

This document also contains the Open edX XBlock Tutorial, which describes XBlock concepts in depth and guides developers through the process of creating an XBlock.

• Change history for XBlock
• Introduction to XBlocks
• XBlock API
• Fields API
• Runtime API
• Plugins API
• Exceptions API
• Open edX XBlock Tutorial
  • Introduction
  • XBlock Overview
    • Introduction to XBlocks
    • XBlock Examples
  • Build an XBlock: Quick Start
    • Install XBlock Prerequisites
    • Set Up the XBlock Software Development Kit
    • Create Your First XBlock
    • What Browsers Do I Need to Support?
  • Anatomy of an XBlock
    • The XBlock Python File
    • The XBlock HTML File
    • The XBlock JavaScript File
    • The XBlock Stylesheets
  • Customize Your XBlock
    • Customize myxblock.py
    • Customize myxblock.html
    • Customize myxblock.js
    • Customize myxblock.css
  • XBlock Concepts
    • XBlock Fields
    • XBlock Methods
    • XBlock Fragments
    • XBlock Children
    • XBlock Runtimes
    • XBlocks, Events, and Grading
  • XBlocks and the edX Platform
    • Open edX Studio as an XBlock Runtime
    • Open edX Learning Management System as an XBlock Runtime
    • Deploy Your XBlock in Devstack
    • Submit Your XBlock to edX
    • Replace a Preinstalled XBlock With a Custom Implementation
  • Open edX Glossary
  • Using XBlock Software Development Kit
    • Getting Started with the XBlock SDK
• Xblock.utils
  • Settings and theme support