open-index/open-npm huggingface dataset:
npm package: @instructure/instructure-theme
Description: A theme for Instructure made by Instructure Inc.
Author: Instructure, Inc. Engineering and Product Design
Latest version: 9.11.1

---
category: packages
---

## instructure-theme

[![npm][npm]][npm-url]
[![MIT License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]

A UI component theme for Instructure made by Instructure Inc.

This theme has a 3:1 minimum contrast requirement.

### Installation

```sh
npm install @instructure/instructure-theme
```

### Usage

Before mounting (rendering) your React application:

- global theming:

  ```js
  import { theme } from '@instructure/instructure-theme'

  theme.use()
  ```

- application level theming:

  ```jsx
  import { theme } from '@instructure/instructure-theme'

  ReactDOM.render(
    <InstUISettingsProvider theme={theme}>
      <App />
    </InstUISettingsProvider>,
    element
  )
  ```

To override the variables:

- globally:

  ```js
  import { theme } from '@instructure/instructure-theme'

  theme.use({ overrides: { colors: { brand: 'red' } } })
  ```

- application level:

  ```jsx
  import { theme } from '@instructure/instructure-theme'
  const themeOverrides = { colors: { brand: 'red' } }

  ReactDOM.render(
    <InstUISettingsProvider theme={{ ...theme, ...themeOverrides }}>
      <App />
    </InstUISettingsProvider>,
    element
  )
  ```

[npm]: https://img.shields.io/npm/v/@instructure/instructure-theme.svg
[npm-url]: https://npmjs.com/package/@instructure/instructure-theme
[license-badge]: https://img.shields.io/npm/l/instructure-ui.svg?style=flat-square
[license]: https://github.com/instructure/instructure-ui/blob/master/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/instructure/instructure-ui/blob/master/CODE_OF_CONDUCT.md
npm package: @instructure/instui-config
Description: A package containing Instructure UI specific configuration data for operations such as upgrades and codemod scripts
Author: Instructure, Inc. Engineering and Product Design
Latest version: 9.11.1

---
category: packages
---

## instui-config

[![npm][npm]][npm-url]
[![MIT License][license-badge]][license]
[![Code of Conduct][coc-badge]][coc]

A package containing Instructure UI specific configuration data for operations
such as upgrades and codemod scripts.

### Installation

```sh
npm install @instructure/instui-config
```

[npm]: https://img.shields.io/npm/v/@instructure/instui-config.svg
[npm-url]: https://npmjs.com/package/@instructure/instui-config
[license-badge]: https://img.shields.io/npm/l/instructure-ui.svg?style=flat-square
[license]: https://github.com/instructure/instructure-ui/blob/master/LICENSE
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/instructure/instructure-ui/blob/master/CODE_OF_CONDUCT.md
npm package: @instructure/k5uploader
Description: html 5 kaltura uploader
Author: Instructure
Latest version: 2.0.1

# K5Uploader

A javascript based uploader for kaltura.

## Installation

`npm install k5uploader`

## Considerations

1. This uploader uses javascript, you may need to set up CORS with your kaltura instance to use it. By default kaltura does not have such headers.

2. The uploader uses xhr2. [Evergreen browsers support it today](http://caniuse.com/#feat=xhr2). Your support needs may limit your ability to use it.

## Usage

```javascript
//grab a file somehow
var file = this.files[0];

// options to configure the uploader
var opts = {
  kaltura_session: {
    ks: '', // valid kaltura session
    subp_id: '', //valid kaltura subpartner id
    partner_id: '', // valid kaltura partner id
    uid: '', // valid kaltura uid
    serverTime: '' // optional timestamp from session
  },
  allowedMediaTypes: ['video', 'audio'], // defaults
  uploadUrl: 'http://kaltura_box.com/index.php/partnerservices2/upload',
  entryUrl: 'http://kaltura_box.com/index.php/partnerservices2/addEntry',
  uiconfUrl: 'http://kaltura_box.com/index.php/partnerservices2/getuiconf',
  entryDefaults: {
    partnerData: "optional custom serialized data here",
  }
};

// create instance with options
var uploader = new K5Uploader(opts);

// wait for 'K5.ready' and upload the file
uploader.addEventListener('K5.ready', function()() {
  uploader.uploadFile(file);
});

```

## Events

The K5Uploader dispatches several events during the upload process. Listen to them or ignore them as your needs dictate.

|Event | Description|
|:---- |:---------- |
|`K5.uiconfError` | there has been an error loading data from the `uiconfUrl` |
| `K5.ready` | a valid kaltura session and uiconf serivce data is loaded. now save to upload |
| `K5.fileError` | uploaded filetype is not included in the `allowedMediaTypes` options |
| `K5.progress` | upload progress is detected |
| `K5.complete` | upload is complete |
| `K5.error` | error uploading file or adding upload via `entryUrl` |

### Dealing with events

In order to register an event handler, the `K5Uploader` includes the following methods:

```javascript
k5Uploader.addEventListener(eventName, callback);
k5Uploader.removeEventListener(eventName, callback)
```
npm package: @instructure/media-capture
Description: --- category: packages experimental: true ---
Author: Instructure, Inc. Engineering and Product Design
Latest version: 12.0.0

---
category: packages
experimental: true
---

## media-capture

### Installation

```sh
yarn add @instructure/media-capture
```

### Browser Support

- Chrome, Firefox

### Usage

```javascript
import React, { Component } from 'react'
import { canUseMediaCapture, CaptureStates }, MediaCapture from '@instructure/media-capture'

export default class Container extends Component {
  saveFile(file) {
    // do something with the file
  },

  mediaCaptureClosed() {
    alert('Recording canceled.')
  },

  render () {
    return (
      { canUseMediaCapture() ?
        <ScreenCapture
          onCompleted={this.saveFile}
          onCancel={this.mediaCaptureClosed}
        /> : null
      }
    )
  }
}

```
npm package: @instructure/outcomes-ui
Description: Outcomes Application for general alignment and assessment
Author: Instructure, Inc. Engineering and Product Design
Latest version: 4.1.4

# Outcomes React Library

This library contains learning standards components used in [Canvas LMS](https://github.com/instructure/canvas-lms), including outcome alignment and reporting.

Components are based on React and Redux, and we follow these organizational [conventions](doc/conventions.md).

[![npm](https://img.shields.io/npm/v/@instructure/outcomes-ui.svg)](https://www.npmjs.com/package/@instructure/outcomes-ui)
[![MIT License](https://img.shields.io/npm/l/@instructure/outcomes-ui.svg?style=flat-square)](https://github.com/instructure/outcomes-ui/blob/master/LICENSE)


## Install

The library can either be built by running `npm install` or via npmjs.com:

```bash
npm install @instructure/outcomes-ui

# or

yarn add @instructure/outcomes-ui
```

## Test

See [testing documentation](doc/testing.md) for details.

## License

[MIT](LICENSE)