@groton/canvas-api.client.web

Web client for @groton/canvas-api that works with PHP package groton-school/slim-canvas-api-proxy

Install

npm install @groton/canvas-api.client.web

Usage

import { Canvas } from '@groton/canvas-api.client.web';

// initialize client (default configuration matches default configuration
// of groton-school/slim-canvas-api-proxy)
await Canvas.init();

const content = document.getElementById('content');

// pull a paginated list of typed users from the API
for (const user of await Canvas.v1.Accounts.Users.list({
  pathParams: { account_id: 1 }
})) {
  const userDisplay = document.createElement('div');
  userDisplay.innerHTML = `<img src="${user.avatar_url}"/>${user.name}`;
  content.appendChild(userDisplay);
}

See groton-school/slim-skeleton's gae/lti-tool_canvas_api_proxy branch for a working example of this client.