зеркало из https://github.com/microsoft/fast.git
chore: remove react packages, tslint packages, and unneeded react references (#3517)
This commit is contained in:
Родитель
4780a9b62a
Коммит
b122f60558
|
@ -30,21 +30,6 @@ build/ @janechu @nicholasrice @chrisdholt @awentzel @EisenbergEffect
|
|||
|
||||
# Package specific owners
|
||||
|
||||
# React
|
||||
/packages/react/fast-components-class-name-contracts-base/ @chrisdholt @janechu @nicholasrice
|
||||
/packages/react/fast-components-class-name-contracts-msft/ @chrisdholt @janechu @nicholasrice
|
||||
/packages/react/fast-components-foundation-react/ @chrisdholt @janechu @nicholasrice
|
||||
/packages/react/fast-components-react-base/ @chrisdholt @janechu @nicholasrice
|
||||
/packages/react/fast-components-react-msft/ @chrisdholt @janechu @nicholasrice
|
||||
/packages/react/fast-components-styles-msft/ @chrisdholt @janechu @nicholasrice
|
||||
/packages/react/fast-jss-manager/ @nicholasrice @janechu @chrisdholt
|
||||
/packages/react/fast-jss-manager-react/ @nicholasrice @janechu @chrisdholt
|
||||
/packages/react/fast-jss-utilities/ @nicholasrice @janechu @chrisdholt
|
||||
/packages/react/fast-layouts-react/ @chrisdholt @nicholasrice
|
||||
/packages/react/fast-react-utilities/ @chrisdholt @nicholasrice
|
||||
/packages/react/fast-storybook-design-system-addon/ @nicholasrice @chrisdholt @janechu
|
||||
/packages/react/fast-storybook-presets/ @nicholasrice @chrisdholt @janechu
|
||||
|
||||
# Tooling
|
||||
/packages/tooling/fast-figma-plugin-msft/ @nicholasrice @bheston @janechu @EisenbergEffect
|
||||
/packages/tooling/fast-tooling-react/ @janechu @nicholasrice @chrisdholt @EisenbergEffect
|
||||
|
|
|
@ -51,15 +51,6 @@ jobs:
|
|||
with:
|
||||
coverageCommand: lerna run coverage
|
||||
coverageLocations: |
|
||||
${{github.workspace}}/packages/react/fast-components-foundation-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-components-react-base/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-components-react-msft/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-components-styles-msft/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-jss-manager/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-jss-manager-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-jss-utilities/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-layouts-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-react-utilities/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/tooling/fast-tooling/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/tooling/fast-tooling-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/utilities/fast-animation/coverage/lcov.info:lcov
|
||||
|
|
|
@ -35,15 +35,6 @@ jobs:
|
|||
with:
|
||||
coverageCommand: lerna run coverage
|
||||
coverageLocations: |
|
||||
${{github.workspace}}/packages/react/fast-components-foundation-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-components-react-base/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-components-react-msft/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-components-styles-msft/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-jss-manager/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-jss-manager-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-jss-utilities/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-layouts-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/react/fast-react-utilities/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/tooling/fast-tooling/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/tooling/fast-tooling-react/coverage/lcov.info:lcov
|
||||
${{github.workspace}}/packages/utilities/fast-animation/coverage/lcov.info:lcov
|
||||
|
|
|
@ -1,30 +0,0 @@
|
|||
/**
|
||||
* Utility for copying readme to their dist folders.
|
||||
* Usage: node build/copy-readme.js
|
||||
*/
|
||||
const path = require("path");
|
||||
const fs = require("fs");
|
||||
const glob = require("glob");
|
||||
|
||||
const rootDir = path.resolve(process.cwd());
|
||||
const srcReadmePaths = "src/**/README.md";
|
||||
const destDir = "dist";
|
||||
|
||||
/**
|
||||
* Function to copy readme files to their dist folder
|
||||
*/
|
||||
function copyReadmeFiles() {
|
||||
const resolvedSrcReadmePaths = path.resolve(rootDir, srcReadmePaths);
|
||||
|
||||
glob(resolvedSrcReadmePaths, void(0), function(error, files) {
|
||||
files.forEach((filePath) => {
|
||||
const destReadmePath = filePath.replace(/(\bsrc\b)(?!.*\1)/, destDir);
|
||||
fs.copyFileSync(filePath, destReadmePath);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Copy all files
|
||||
*/
|
||||
copyReadmeFiles();
|
|
@ -1,168 +0,0 @@
|
|||
/**
|
||||
* Utility for copying and mocking the copying of readme files from packages to .docs/en/packages/[package-name]/readme.md.
|
||||
* Usage (copy):run node build/documentation/copy-package-readme.js OR
|
||||
* yarn docs:build
|
||||
* Usage (dry-run):run node build/documentation/copy-package-readme.js --dry-run OR
|
||||
* yarn docs:dry-run
|
||||
*/
|
||||
const path = require("path");
|
||||
const fs = require("fs");
|
||||
const glob = require("glob");
|
||||
const chalk = require("chalk");
|
||||
|
||||
const rootDir = path.resolve(process.cwd());
|
||||
const srcReadmePaths = "packages/*/*/?(readme.md|README.md)";
|
||||
const destDir = path.join("docs", "en", "packages/");
|
||||
const srcSidebar = path.join("sites/website", "sidebars.json");
|
||||
|
||||
var dryRun = false;
|
||||
var sidebarEntries = [];
|
||||
|
||||
var totalDocsCount;
|
||||
var updatedDocsCount = 0;
|
||||
|
||||
/**
|
||||
* Determine if a dry run will be executed based off --dry-run argument being present
|
||||
* if an invalid third parameter is entered, the application will exit
|
||||
*/
|
||||
process.argv.forEach(function (val, index) {
|
||||
var validArg = true;
|
||||
|
||||
if (index == 2) {
|
||||
val === "--dry-run" ? (dryRun = true) : (validArg = false);
|
||||
}
|
||||
|
||||
if (!validArg) {
|
||||
console.log(
|
||||
chalk.red("Invalid argument used. To perform a dry-run use --dry-run")
|
||||
);
|
||||
process.exit(1);
|
||||
}
|
||||
});
|
||||
|
||||
/**
|
||||
* Function to copy readme files to the ./docs/en/packages folder
|
||||
* and update Docusaurus sidebar, ./website/sidebars.json
|
||||
*/
|
||||
function copyReadmeFiles() {
|
||||
const resolvedSrcReadmePaths = path.resolve(rootDir, srcReadmePaths);
|
||||
|
||||
dryRun
|
||||
? console.log(`In ${destDir}, this script would...`)
|
||||
: console.log(`In ${destDir}...`);
|
||||
|
||||
fs.readdir("packages", (err, files) => {
|
||||
totalDocsCount = files.length;
|
||||
});
|
||||
|
||||
createDirectory(destDir);
|
||||
glob(resolvedSrcReadmePaths, { realpath: true }, function (error, srcFiles) {
|
||||
srcFiles.forEach(srcReadmePath => {
|
||||
createDestReadme(srcReadmePath);
|
||||
const srcDirPath = path.dirname(srcReadmePath);
|
||||
const lastSrcDir = srcDirPath.split(path.sep).pop();
|
||||
|
||||
sidebarEntries.push(`en/packages/${lastSrcDir}/index`);
|
||||
});
|
||||
|
||||
console.log(
|
||||
chalk.green(
|
||||
`${updatedDocsCount} of ${totalDocsCount} package readme.md files updated`
|
||||
)
|
||||
);
|
||||
updateSidebar();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds a new readme in ./docs/en/packages
|
||||
* Creates and adds a docusaurus header to the new file
|
||||
* Then appends the original readme from .docs/en/packages/[package-name]
|
||||
*/
|
||||
function createDestReadme(srcReadmePath) {
|
||||
const destReadmePath = srcReadmePath.replace(
|
||||
/(\bpackages\/\b)(\breact\/\b|\btooling\/\b|\butilities\/\b)(?!.*\1)/,
|
||||
destDir
|
||||
);
|
||||
|
||||
const destDirPath = path.dirname(destReadmePath);
|
||||
const srcDirPath = path.dirname(srcReadmePath);
|
||||
const srcReadmeText = fs.readFileSync(srcReadmePath).toString();
|
||||
|
||||
var folderName = srcDirPath.split(path.sep).pop();
|
||||
|
||||
var lines = fs.readFileSync(srcReadmePath, "utf-8").split("\n").filter(Boolean);
|
||||
|
||||
var title = lines[0].replace(/#/g, "").replace(/FAST/g, "").trim();
|
||||
|
||||
var docusaurusHeader =
|
||||
`---\n` +
|
||||
`id: index\n` +
|
||||
`title: FAST ${title}\n` +
|
||||
`sidebar_label: ${title}\n` +
|
||||
`---\n\n`;
|
||||
|
||||
createDirectory(destDirPath);
|
||||
|
||||
if (dryRun) {
|
||||
if (fs.existsSync(destReadmePath)) {
|
||||
console.log(`...REPLACE readme.md in the '${folderName}' folder`);
|
||||
} else {
|
||||
console.log(`...ADD readme.md to the '${folderName}' folder`);
|
||||
}
|
||||
} else {
|
||||
try {
|
||||
fs.writeFileSync(destReadmePath, docusaurusHeader);
|
||||
fs.appendFileSync(destReadmePath, srcReadmeText);
|
||||
updatedDocsCount++;
|
||||
console.log(`...${folderName} was succesfully updated`);
|
||||
} catch (err) {
|
||||
console.log(chalk.red(err));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Updates ./website/sidebars.json
|
||||
*/
|
||||
function updateSidebar() {
|
||||
var sidebarJSONPath = path.resolve(rootDir, srcSidebar);
|
||||
const sidebarText = fs.readFileSync(sidebarJSONPath).toString();
|
||||
var sidebarJSON = JSON.parse(sidebarText);
|
||||
sidebarJSON.docs.Packages = [];
|
||||
|
||||
sidebarEntries.map(entry => sidebarJSON.docs.Packages.push(entry));
|
||||
|
||||
if (dryRun) {
|
||||
console.log(
|
||||
"In website/sidebars.json, this script updates...\n" +
|
||||
"...the Packages array with the filepath to each package's index file."
|
||||
);
|
||||
} else {
|
||||
fs.writeFile(
|
||||
sidebarJSONPath,
|
||||
JSON.stringify(sidebarJSON, null, 2),
|
||||
"utf8",
|
||||
err => {
|
||||
if (err) throw err;
|
||||
console.log(chalk.green(`${srcSidebar} was succesfully updated!`));
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility function that creates new folders
|
||||
* based off dir argument
|
||||
*/
|
||||
function createDirectory(dir) {
|
||||
if (!fs.existsSync(dir)) {
|
||||
dryRun ? console.log(`...CREATE the '${dir}' folder.`) : fs.mkdirSync(dir);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run script
|
||||
* Based off presence of --dry-run parameter
|
||||
*/
|
||||
copyReadmeFiles();
|
|
@ -1,193 +0,0 @@
|
|||
/**
|
||||
* Utility for generating TypeDoc API documentation and placing it in the docs/en/packages folder so it can be hosted by
|
||||
* GitHub pages and viewed through Docusaurus.
|
||||
* Contains a dry run command to investigate how the script will operate without actually writing to anything.
|
||||
* Contains a verbose option to print detailed build output generated by the typedoc processes that create the
|
||||
* api documentation.
|
||||
*
|
||||
* Usage :run node build/documentation/generate-typedocs.js OR
|
||||
* Usage (dry-run): run node build/documentation/generate-typedocs.js --dry-run
|
||||
* Usage (verbose): run node build/documentation/generate-typedocs.js --verbose
|
||||
*/
|
||||
|
||||
const path = require("path");
|
||||
const fs = require("fs");
|
||||
const glob = require("glob");
|
||||
const os = require("os");
|
||||
const chalk = require("chalk");
|
||||
const yargs = require("yargs");
|
||||
|
||||
const { exec } = require("child_process");
|
||||
const { spawn } = require("child_process");
|
||||
|
||||
const rootDir = path.resolve(process.cwd());
|
||||
const srcDir = "packages/*/*";
|
||||
const destDir = path.join("docs", "en", "packages");
|
||||
|
||||
var copyReadmeScript = "copy-package-readme.js";
|
||||
var copyReadmeScriptPath = path.join("build", "documentation", copyReadmeScript);
|
||||
var dryRun = false;
|
||||
var verbose = false;
|
||||
|
||||
const excludedPackages = ["fast-eslint-rules", "fast-tslint-rules"];
|
||||
|
||||
/**
|
||||
* Obtain command line aguments
|
||||
* If present when the script is run, their corresponding flags get set to true
|
||||
*/
|
||||
const argv = yargs.argv;
|
||||
dryRun = argv.dryRun;
|
||||
verbose = argv.verbose;
|
||||
|
||||
/**
|
||||
* Run the copy readme script, then this one if successful
|
||||
* To prevent new links constantly being appended to the readme every
|
||||
* time the script is run, the copy readme script is run to regenerate
|
||||
* files to their original form with the needed header
|
||||
*/
|
||||
|
||||
var proc = dryRun
|
||||
? exec(`node ${copyReadmeScriptPath} --dry-run`)
|
||||
: exec(`node ${copyReadmeScriptPath}`);
|
||||
|
||||
proc.stdout.on("data", function (data) {
|
||||
process.stdout.write(data);
|
||||
});
|
||||
|
||||
proc.on("error", err => {
|
||||
console.log(chalk.red(err));
|
||||
});
|
||||
|
||||
proc.on("close", function (code) {
|
||||
console.log(chalk.green(`${copyReadmeScript} ran successfully.`));
|
||||
execute();
|
||||
});
|
||||
|
||||
/**
|
||||
* Generate TypeDocs for each package
|
||||
*/
|
||||
function execute() {
|
||||
if (dryRun) {
|
||||
console.log(`In ${destDir}, this script would...`);
|
||||
} else {
|
||||
console.log(`Generating API documentation using TypeDoc...`);
|
||||
}
|
||||
|
||||
const packages = path.resolve(rootDir, srcDir);
|
||||
|
||||
glob(packages, { realpath: true }, function (error, srcFiles) {
|
||||
srcFiles.forEach(srcPath => {
|
||||
var valid = true;
|
||||
|
||||
var packageName = srcPath.split(path.sep).pop();
|
||||
|
||||
excludedPackages.forEach(excludedPackageName => {
|
||||
if (packageName === excludedPackageName) {
|
||||
console.log(
|
||||
chalk.yellow(
|
||||
`...skip generating TypeDoc API files for ${packageName}`
|
||||
)
|
||||
);
|
||||
valid = false;
|
||||
}
|
||||
});
|
||||
|
||||
if (valid) {
|
||||
dryRun
|
||||
? console.log(`...generate TypeDoc API files for ${packageName}`)
|
||||
: createAPIFiles(packageName, srcPath);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Uses TypeDoc process to generate API docs for a given package
|
||||
* Stores them in the docs/en/packages folder
|
||||
*/
|
||||
function createAPIFiles(packageName, srcPath) {
|
||||
var config = path.join(srcPath, "/build.tsconfig.json");
|
||||
var output = path.join(destDir, packageName, "api");
|
||||
var file =
|
||||
packageName === "fast-animation"
|
||||
? path.join(srcPath, "/lib/index.ts")
|
||||
: path.join(srcPath, "/src/index.ts");
|
||||
|
||||
var typedocCmd = os.platform() == "win32" ? "typedoc.cmd" : "typedoc";
|
||||
var typedocPath = path.join("node_modules", ".bin", typedocCmd);
|
||||
|
||||
const typedoc = spawn(
|
||||
typedocPath, // the local TypeDoc installation is needed for the markdown theme to work
|
||||
[
|
||||
"--tsconfig",
|
||||
config,
|
||||
"--excludeNotExported",
|
||||
"--out",
|
||||
output,
|
||||
file,
|
||||
"--theme",
|
||||
"markdown",
|
||||
]
|
||||
);
|
||||
|
||||
typedoc.on("close", code => {
|
||||
if (code) {
|
||||
console.log(
|
||||
chalk.red(
|
||||
`${packageName} - TypeDoc API docs not generated, error code: ${code}`
|
||||
)
|
||||
);
|
||||
} else {
|
||||
console.log(`${packageName} - TypeDoc API docs generated`);
|
||||
addHeaderToReadme(packageName);
|
||||
addAPILinkToReadme(packageName);
|
||||
}
|
||||
});
|
||||
|
||||
// if set to true, will print detailed build output for typedoc process
|
||||
// useful for debugging
|
||||
if (verbose) {
|
||||
typedoc.stdout.on("data", data => {
|
||||
console.log(`${data}`);
|
||||
});
|
||||
}
|
||||
|
||||
typedoc.on("error", err => {
|
||||
console.log(chalk.red(err));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* If the TypeDoc readme doesn't have this header
|
||||
* It won't be accessible in docusaurus
|
||||
*/
|
||||
function addHeaderToReadme(packageName) {
|
||||
const readmePath = path.join(destDir, packageName, "api", "README.md");
|
||||
const readmeText = fs.readFileSync(readmePath).toString();
|
||||
|
||||
var docusaurusHeader = `---\n` + `id: index\n` + `---\n\n`;
|
||||
|
||||
try {
|
||||
fs.writeFileSync(readmePath, docusaurusHeader);
|
||||
fs.appendFileSync(readmePath, readmeText);
|
||||
} catch (err) {
|
||||
console.log(chalk.red(err));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates link in package readme.md docs used by Docusaurus
|
||||
* Said link routes to the TypeDoc API docs generated by this script
|
||||
*/
|
||||
function addAPILinkToReadme(packageName) {
|
||||
var readmePath = path.join(destDir, packageName, "README.md");
|
||||
var apiLink = "api";
|
||||
|
||||
var usageText = "\n" + `[API Reference](${apiLink})`;
|
||||
|
||||
fs.appendFile(readmePath, usageText, function (err) {
|
||||
if (err) {
|
||||
console.log(chalk.red(err));
|
||||
}
|
||||
});
|
||||
}
|
|
@ -1,51 +0,0 @@
|
|||
---
|
||||
id: install
|
||||
title: Install
|
||||
sidebar_label: Install
|
||||
---
|
||||
|
||||
# Install
|
||||
|
||||
## Prerequisites
|
||||
|
||||
Before setting up FAST, install Git and <a href="https://yarnpkg.com/en/docs/install" target="_blank">Yarn</a>.
|
||||
|
||||
## Setup the source repository
|
||||
|
||||
Clone the repository, `cd` into the project, install <a href="https://github.com/lerna/lerna" target="_blank">Lerna</a> and install dependencies:
|
||||
|
||||
```shell
|
||||
git clone https://github.com/Microsoft/fast.git
|
||||
cd fast
|
||||
yarn global add lerna
|
||||
```
|
||||
|
||||
Installs all the dependencies:
|
||||
|
||||
```shell
|
||||
yarn
|
||||
```
|
||||
|
||||
Builds all the packages:
|
||||
|
||||
```shell
|
||||
lerna run prepare
|
||||
```
|
||||
|
||||
- `yarn eslint` or `yarn eslint:fix` executes eslint in a given package.
|
||||
- `yarn unit-tests` executes unit testing for packages.
|
||||
- `yarn test` executes processes in a package required to pass before check-in and generally includes building, linting, and unit testing.
|
||||
|
||||
To run these processes across *all* projects, substitute `yarn` for `lerna run ____`:
|
||||
|
||||
```shell
|
||||
lerna run test
|
||||
```
|
||||
|
||||
## Understanding packages
|
||||
|
||||
All packages can be found in the repository [packages](https://github.com/Microsoft/fast/tree/master/packages) folder. Each package includes a `README.md` at its root for documentation.
|
||||
|
||||
## Dependencies
|
||||
|
||||
Dependencies are minimized to simplify upgrade cycles and encourage frequent updates with less friction and reduced impact.
|
|
@ -1,138 +0,0 @@
|
|||
---
|
||||
id: packages
|
||||
title: Packages
|
||||
sidebar_label: Packages
|
||||
---
|
||||
|
||||
# Packages
|
||||
|
||||
Before contributing a new package, it will go through a proposal process to be accepted by the Steering Committee.
|
||||
|
||||
## Folder structure
|
||||
|
||||
### Tracked folders
|
||||
|
||||
Always include an `src` folder at the root level of the package. The `src` folder should include all of the un-minified source code and test files for the project. Place test files in the same folder as the file they are testing and name it using the `*.spec.ts` or `*.spec.tsx` pattern.
|
||||
|
||||
When it is necessary to create a testing folder, it should be named `__tests__`.
|
||||
|
||||
For TypeScript projects, export all relevant files from the `index.ts` or `index.tsx` file in the `src` folder so that, when importing, only the folder name is needed. Keep the folder structure as flat as possible.
|
||||
|
||||
When a testing application is needed, it should be created in an `app` directory at the root of the package.
|
||||
|
||||
![Example of tracked folder structure with fast-package at the top and __tests__, app and src inside.](https://res.cloudinary.com/fast-dna/image/upload/v1546297640/creating_packages_tracked_folders.webp "")
|
||||
*Example structure for tracked folders.*
|
||||
|
||||
### Untracked folders
|
||||
|
||||
Untracked folders are folders included in the `.gitignore` and generated by an automated process.
|
||||
|
||||
These may include:
|
||||
|
||||
* A `node_modules` folder for npm dependencies -- generated by the `npm i` command.
|
||||
* A `dist` folder for the exported code -- generated by compiling TypeScript and specified by the `tsconfig.json`.
|
||||
* A `www` folder for exported compiled applications if creating an `app` folder -- generated by `webpack` and specified by the `webpack.config.js`.
|
||||
* A `coverage` folder for test coverage reporting.
|
||||
|
||||
## package.json
|
||||
|
||||
All packages use npm and are published to the [npm registry](https://www.npmjs.com/).
|
||||
|
||||
### Side effects
|
||||
|
||||
All packages are expected to be side-effect free. Adding a `"sideEffects": false` flag to the package.json indicates to tools like webpack that the package's modules have no side effects (on evaluation) and only expose exports. This allows these tools to optimize re-exports through tree-shaking and dead code removal.
|
||||
|
||||
### Scripts
|
||||
|
||||
Unless specified, scripts are defined in the `package.json` scripts property so they can be run with `npm run [script-name]`.
|
||||
|
||||
The following scripts are required:
|
||||
|
||||
* `npm run build` builds the exported package.
|
||||
* `npm run clean:dist` cleans the distribution folder.
|
||||
* `npm run prepare` cleans the distribution folder and builds the exported package.
|
||||
* `npm run prettier` ensures code is formatted correctly (runs on a global repository githook).
|
||||
* `npm run prettier:diff` provides a hook to ensure code formatting matches expectations on the build server.
|
||||
* `npm run test` runs all tests.
|
||||
* `npm run eslint` runs eslint.
|
||||
|
||||
Additional scripts and common use cases include:
|
||||
|
||||
* `npm start` starts the webpack-dev-server.
|
||||
* `npm run eslint:fix` runs eslint with the fix option.
|
||||
* `npm run watch` watches the files and builds the exported package when making changes to the source files.
|
||||
|
||||
## .npmignore
|
||||
|
||||
The `.npmignore` file removes:
|
||||
|
||||
* All testinging files; usually by targetting the `__tests__`, `*.spec.*` and `*.test.*` patterns.
|
||||
* All unminified code; usually by targetting the `src` folder.
|
||||
* The `babel.config.js` if it has been added to the package.
|
||||
|
||||
## Webpack
|
||||
|
||||
A Webpack application can be created using `webpack` and `webpack-dev-server` for testing and/or documentation purposes. If it is necessary to publish a webpack application that serves as a documentation site to a live site, a production webpack build should be made available.
|
||||
|
||||
Applications using `webpack-dev-server` can also serve as a means for testing using E2E testing frameworks.
|
||||
|
||||
## Typescript
|
||||
|
||||
Use TypeScript for packages that include JavaScript and make sure to add `tsconfig.json` and `.eslintrc.js` files.
|
||||
|
||||
Published packages must be in ES6 module format to support tree-shaking.
|
||||
|
||||
## README format
|
||||
|
||||
```markdown
|
||||
# [packageName] <!-- e.g. FAST Animation -->
|
||||
|
||||
<!-- format: A[n] [what: e.g. library,library of components] for [what does it do?]. -->
|
||||
[packageDescription]
|
||||
|
||||
## Benefits
|
||||
|
||||
<!-- List the key benefits of the package -->
|
||||
* [packageBenefit1]
|
||||
* [packageBenefit2]
|
||||
|
||||
## Package status
|
||||
<!-- If package is not a proposal or experimental status, delete this section -->
|
||||
|
||||
<!-- Delete one to show the status: -->
|
||||
:soon: **Proposal: This package contains code and APIs may change and have gaps in stability, testing and documentation. Your feedback is encouraged.**
|
||||
|
||||
:sos: **Experimental: This package contains code and APIs are likely to change, may not be stable, and may be missing tests and documentation.**
|
||||
|
||||
## Usage
|
||||
|
||||
### Installation
|
||||
|
||||
[installationGuidance]
|
||||
|
||||
### Getting started
|
||||
<!-- When possible, provide a brief overview of how to use the package. This should be the minimum work required to get a meaningful understanding of how the package works -->
|
||||
|
||||
[gettingStartedGuidance]
|
||||
|
||||
### Properties/Configuration/etc.
|
||||
<!-- Describe in detail, how to use the package. This includes APIs, configurations, ... -->
|
||||
|
||||
[detailedGuidance]
|
||||
|
||||
## Examples
|
||||
<!-- If possible, show one or more examples. -->
|
||||
|
||||
[Examples]
|
||||
|
||||
## Exports
|
||||
<!-- If applicable, describe the package exports and if they require additional configuration, for example because they are exported as ES6 and therefore need babel or some other method of transpiling to ES2015. -->
|
||||
|
||||
[Exports]
|
||||
|
||||
## Additional resources
|
||||
|
||||
<!-- If there are additional resources, include them here. -->
|
||||
[Resource 1](https://)
|
||||
[Resource 2](https://)
|
||||
```
|
|
@ -1,11 +0,0 @@
|
|||
---
|
||||
id: policies
|
||||
title: Policies
|
||||
sidebar_label: Policies
|
||||
---
|
||||
|
||||
# Policies
|
||||
|
||||
* [Licensing](https://github.com/Microsoft/fast/blob/master/LICENSE)
|
||||
* [Contributions](https://github.com/Microsoft/fast/blob/master/CONTRIBUTING.md)
|
||||
* [Code of Conduct](https://github.com/Microsoft/fast/blob/master/CODE_OF_CONDUCT.md)
|
|
@ -1,40 +0,0 @@
|
|||
---
|
||||
id: standards
|
||||
title: Standards
|
||||
sidebar_label: Standards
|
||||
---
|
||||
|
||||
# Standards
|
||||
|
||||
Our contributors use these standards for consistency and quality in the repository.
|
||||
|
||||
## Naming conventions
|
||||
|
||||
* Avoid abbreviations unless they are common industry acronyms.
|
||||
* Use names that are clear and intuitive.
|
||||
* Use semantic names instead of presentational.
|
||||
|
||||
## Accessibility
|
||||
|
||||
Accessibility is acknowledged from the start of each new feature and must be addressed in a specification in the created issue before work can begin.
|
||||
|
||||
### Animation
|
||||
|
||||
* Users should have a mechanism to reduce or remove animations from their experience. The Safari developers have proposed a media query for reduced animation. ("prefers-reduced-motion"). Animations longer than 3 seconds must provide a way to stop the motion.
|
||||
* Some users with vestibular disorders or other cognitive disabilities have problems with movement. A safe fallback for nearly all users is fade animations.
|
||||
* Avoid flashing animations can cause seizures or discomfort.
|
||||
|
||||
## JSS usage
|
||||
|
||||
JSS (JavaScript Style Sheets) class names interfaces follow a [BEM-like](http://getbem.com/naming/) convention but our implementation of BEM is slightly modified because dashes — the character used to delimit *modifiers* — cannot be used as JavaScript object keys without using string literals; we use underscores instead. A single underscore separates an element from a block while two underscores separate a modifier from a block or element.
|
||||
|
||||
Example:
|
||||
|
||||
```html
|
||||
block_element__modifier
|
||||
```
|
||||
|
||||
Within a block, element, or modifier, words should be camelCased:
|
||||
|
||||
```html
|
||||
anotherBlock_anotherElement__anotherModifier
|
|
@ -1,29 +0,0 @@
|
|||
---
|
||||
id: status
|
||||
title: Status
|
||||
sidebar_label: Status
|
||||
---
|
||||
|
||||
# Status
|
||||
|
||||
This page can be used to display the health of FAST systems.
|
||||
|
||||
* [Circle CI - Status](https://status.circleci.com/)
|
||||
* [Code Climate - Status](https://status.codeclimate.com/)
|
||||
* [Azure DevOps - Status](https://status.dev.azure.com/)
|
||||
|
||||
## Azure DevOps Pipeline
|
||||
|
||||
### Component Explorer
|
||||
|
||||
#### Builds (CI)
|
||||
|
||||
[![Build Status](https://dev.azure.com/edgewebui/FAST/_apis/build/status/Component%20Explorer%20-%20CI?branchName=master)](https://dev.azure.com/edgewebui/FAST/_build/latest?definitionId=65&branchName=master)
|
||||
|
||||
#### Deployments (CD)
|
||||
|
||||
| Staging | Production |
|
||||
|--|--|
|
||||
|[![Build status](https://vsrm.dev.azure.com/edgewebui/_apis/public/Release/badge/db5c5831-7b32-4ef1-9e7d-205361d49e08/2/2)](https://explore-stage.azurewebsites.net) |[![Build Status](https://vsrm.dev.azure.com/edgewebui/_apis/public/Release/badge/db5c5831-7b32-4ef1-9e7d-205361d49e08/2/3)](https://explore.fast.design) |
|
||||
| https://explore-stage.azurewebsites.net | https://explore.fast.design |
|
||||
Automatically released after commit to master | Manually released after design approval
|
|
@ -1,139 +0,0 @@
|
|||
---
|
||||
id: testing
|
||||
title: Testing
|
||||
sidebar_label: Testing
|
||||
---
|
||||
|
||||
# Testing
|
||||
|
||||
## Checklist
|
||||
|
||||
This testing checklist is a good starting point for manual testing web applications.
|
||||
|
||||
1. Test each page for design and content issues
|
||||
1. Test screen sizes from viewport 1 to 6
|
||||
2. Test screen orientations
|
||||
1. Portrait
|
||||
2. Landscape
|
||||
3. Test word length and case
|
||||
1. Test the smallest amount of text
|
||||
2. Test the largest amount of text
|
||||
3. Case sensitivity
|
||||
2. Test for localization (RTL, LTR)
|
||||
3. Test for progressive enhancement
|
||||
1. Test complete browser matrix
|
||||
2. Test for zooming browser from 200% and 25%
|
||||
4. Test each component and pages for accessibility issues
|
||||
1. Test for keyboard accessibility
|
||||
2. Test for Mouse only interaction
|
||||
3. Test for Touch interaction
|
||||
4. Test with High Contrast of OS
|
||||
5. Test without images
|
||||
6. Test for text only
|
||||
7. Test with a screen reader
|
||||
|
||||
## Manual testing
|
||||
|
||||
FAST UI development tools offer a solution for manually testing components during development. Easily test with features such as viewport, localized direction (RTL or LTR), background transparency, color themes, and interactive properties.
|
||||
|
||||
Additionally, we offer testing services under `./build/testing` that can be used to assist in comprehensive testing. We have included these configurations and tests as a starting point. Run the tests manually, and the cloud services dashboard can be used to evaluate your code changes before submitting for code review.
|
||||
|
||||
### Testing on physical devices
|
||||
|
||||
When testing local code on physical devices, Localtunnel allows you to easily share a web service on your local machine without managing DNS and firewall settings.
|
||||
|
||||
Localtunnel assigns a unique publicly accessible URL that proxies all requests to your local web server.
|
||||
|
||||
#### Quickstart
|
||||
|
||||
Install Localtunnel globally (requires NodeJS):
|
||||
|
||||
```bash
|
||||
npm install -g localtunnel
|
||||
```
|
||||
|
||||
* Start a web server on a local port (eg, [http://localhost:8000](http://localhost:8000)) and use the command line interface to request a tunnel to the local server:
|
||||
|
||||
```bash
|
||||
lt --port 8000
|
||||
```
|
||||
|
||||
* You receive a URL to share as long as your local instance remains active. Requests route to your local service at the specified port.
|
||||
|
||||
### Testing with Sauce Labs
|
||||
|
||||
[Sauce Labs](https://saucelabs.com/beta/dashboard/builds) lets collaborators and contributors execute automated tests against Selenium WebDriver on pre-configured browser matrix's.
|
||||
|
||||
The cross-browser testing strategy focuses on the differences between browser rendering engines. There are three different [configuration files](https://github.com/Microsoft/fast/tree/master/build/testing) based on feature maturity of ongoing work.
|
||||
|
||||
[Alpha](https://github.com/Microsoft/fast/blob/master/build/testing/config-browsers.alpha.js) - immature feature development:
|
||||
|
||||
```bash
|
||||
node build/testing/sauce-labs/test-browsers.js alpha
|
||||
```
|
||||
|
||||
[Beta](https://github.com/Microsoft/fast/blob/master/build/testing/config-browsers.beta.js) - stable feature development:
|
||||
|
||||
```bash
|
||||
node build/testing/sauce-labs/test-browsers.js beta
|
||||
```
|
||||
|
||||
[Release](https://github.com/Microsoft/fast/blob/master/build/testing/config-browsers.release.js) - mature feature development:
|
||||
|
||||
```bash
|
||||
node build/testing/sauce-labs/test-browsers.js release
|
||||
```
|
||||
|
||||
### Testing with Applitools
|
||||
|
||||
[Applitools](https://eyes.applitools.com/) can be used to run visual regression tests on UI changes for your branches and allows you to execute automated tests against Selenium WebDriver with ChromeDriver and FirefoxDriver.
|
||||
|
||||
Before making any UI changes on a new branch, run Applitools to create a baseline set of images.
|
||||
|
||||
1. When executing a test for the first time on a new branch, Applitools generates screenshots with an 'undefined' status.
|
||||
2. Once the tests finish, users should select all checkboxes and click **save** to generate the baseline image.
|
||||
3. Make changes to your UI code.
|
||||
4. Rerun the first set of tests and for all snapshots that match the baseline - the images turn green and show as 'passed' status. Any images with 'undefined' status would be caused by additional UI changes. Getting into this state requires new test cases in the `./run-msft-docs.js` file. Anomalies marked red have a 'failed' status.
|
||||
5. Manually verify all the UI changes and save the new baseline.
|
||||
|
||||
Once undesired changes are fixed, retest:
|
||||
|
||||
```bash
|
||||
node build/testing/applitools/test-javascript.js
|
||||
```
|
||||
|
||||
#### Visual Regression testing with Cypress SDK
|
||||
|
||||
Contributors can perform functional user interface and experience testing using [Cypress](https://www.cypress.io/).
|
||||
|
||||
To validate Cypress is configured correctly:
|
||||
|
||||
```bash
|
||||
npm run ui-tests:verify
|
||||
```
|
||||
|
||||
Execute through Electron for real-time user interaction and debugging:
|
||||
|
||||
```bash
|
||||
npm run ui-tests:open
|
||||
```
|
||||
|
||||
Execute using the CLI:
|
||||
|
||||
```bash
|
||||
npm run ui-tests:run
|
||||
```
|
||||
|
||||
When running as CLI, the results can be viewed printing to the command screen or in the cloud dashboard.
|
||||
|
||||
## Cross browser testing
|
||||
|
||||
You can read more from [Mozilla](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Cross_browser_testing/Introduction) on cross-browser testing and processes.
|
||||
|
||||
Report browser bugs by following these links:
|
||||
|
||||
* [Edge](https://developer.microsoft.com/en-us/microsoft-edge/platform/issues/)
|
||||
* [Firefox](https://bugzilla.mozilla.org/)
|
||||
* [Safari](https://bugs.webkit.org/)
|
||||
* [Chrome](https://bugs.chromium.org/p/chromium/issues/list)
|
||||
* [Opera](https://bugs.opera.com/wizard/desktop)
|
|
@ -1,95 +0,0 @@
|
|||
---
|
||||
id: working
|
||||
title: Working
|
||||
sidebar_label: Working
|
||||
---
|
||||
|
||||
# Working
|
||||
|
||||
## Managing issues
|
||||
|
||||
Well crafted issues improve the speed that work can be triaged, understood, and completed. To help guide this process [issue templates](https://github.com/Microsoft/fast/tree/master/.github/ISSUE_TEMPLATE) exist to allow users to choose an appropriate [bug report](https://github.com/Microsoft/fast/blob/master/.github/ISSUE_TEMPLATE/report-a-bug.md) or [feature request](https://github.com/Microsoft/fast/blob/master/.github/ISSUE_TEMPLATE/request-a-feature.md).
|
||||
|
||||
Here's an excellent resource for [do's and don'ts](https://hackernoon.com/45-github-issues-dos-and-donts-dfec9ab4b612) when working with bugs, issues, and requests.
|
||||
|
||||
[GitHub labels](https://developer.github.com/v3/issues/labels/) are used to manage issues broadly considered work items grouped by color and prefixed by label name.
|
||||
|
||||
## Pull requests
|
||||
|
||||
When landing a pull request (PR), individuals must modify the original commit message to include comprehensive details. This detail along with other git history meta information deploys as part of the documentation changelog history. Changelogs are generated by [Lerna](https://lernajs.io/) using [conventional commits](https://conventionalcommits.org/).
|
||||
|
||||
PR commit messages should include the issue number per the [github closing issue keywords](https://help.github.com/articles/closing-issues-using-keywords/) documentation.
|
||||
|
||||
One or more collaborators are automatically assigned to review each PR based on areas of [ownership](https://github.com/Microsoft/fast/blob/master/.github/CODEOWNERS).
|
||||
|
||||
When a peer review is created, a [template](https://github.com/Microsoft/fast/blob/master/.github/pull_request_template.md) is provided that includes the best practices and processes for a review message.
|
||||
|
||||
### Interim commits
|
||||
|
||||
The above outlines the format for the **final** commit, but contributors have many interim commits while working on their branch. These commits should be succinct, concise, and consistent for best readability. Always remember, a diff tells you _what_ changed in a commit, but only the commit message can adequately tell you _why_.
|
||||
|
||||
Typical interim commits may look like the following:
|
||||
|
||||
```bash
|
||||
5ba3db6 update toggle markup for accessibility
|
||||
84564a0 add border styles
|
||||
887815f remove toggle underline on hover
|
||||
```
|
||||
|
||||
Before submitting a pull request, [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch from master or use the *update* button provided by GitHub.
|
||||
|
||||
## Common commands
|
||||
|
||||
All "packages" share common script names for consistency along with their documentation guides.
|
||||
|
||||
To clean all packages node_modules:
|
||||
|
||||
```bash
|
||||
lerna clean
|
||||
```
|
||||
|
||||
To clean dependencies hoisted by yarn, navigate to the root of the project and run:
|
||||
|
||||
```bash
|
||||
rm -rf node_modules
|
||||
```
|
||||
|
||||
Install remote dependencies, build, and symlink local dependencies:
|
||||
|
||||
```bash
|
||||
yarn install
|
||||
lerna run prepare
|
||||
```
|
||||
|
||||
To run all tests on all packages:
|
||||
|
||||
```bash
|
||||
lerna run test
|
||||
```
|
||||
|
||||
To run all tests on a single package:
|
||||
|
||||
```bash
|
||||
cd packages/package-name
|
||||
yarn test
|
||||
```
|
||||
|
||||
Most packages have a _watch_ command that rebuilds the package's distribution when a file changes. This process can be useful when doing development across multiple packages:
|
||||
|
||||
```bash
|
||||
yarn watch
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
If you run into any errors and they seem unrelated to your work try the following procedure:
|
||||
|
||||
Delete root node_modules (`fast/node_modules`) then:
|
||||
|
||||
```bash
|
||||
lerna clean
|
||||
yarn install
|
||||
lerna run test
|
||||
```
|
||||
|
||||
See if your issue reproduces.
|
|
@ -1,204 +0,0 @@
|
|||
---
|
||||
id: writing-style-guide
|
||||
title: Writing style guide
|
||||
sidebar_label: Writing style guide
|
||||
---
|
||||
|
||||
# Writing style guide
|
||||
|
||||
Most writing guidelines used for this project come from the [Chicago Manual of Style][CMoS] and [The Associated Press Stylebook][APS]. When these two publications have conflicting guidance, the Chicago Manual of Style is usually preferred.
|
||||
|
||||
We recognize that many of our contributors may not have access to these paid resources, so we provide a *style guide amendment* that covers many of the most common issues as well as some guidance that is different for this project, or is not covered in other guides.
|
||||
|
||||
For guidance not covered by this amendment, several free resources can be used as a supplement:
|
||||
|
||||
* [The National Geographic style manual][NGSM]
|
||||
* [The Guardian and Observer style guide][GaOSG]
|
||||
* [The BBC News style guide][TBNS]
|
||||
|
||||
## Style guide amendment
|
||||
|
||||
### Punctuation
|
||||
|
||||
**Parentheses with periods**: When a complete sentence is inside of parentheses, place the period inside the ending parenthesis. If the words are not a complete sentence the period or other punctuation goes on the outside.
|
||||
|
||||
A complete sentence in parenthesis:
|
||||
|
||||
> (The first time it said 'hello world,' I knew we would be friends.)
|
||||
|
||||
A sentence fragment in parenthesis:
|
||||
|
||||
> The first time it said 'hello world,' I knew we would be friends (and we still are).
|
||||
|
||||
**Quotation marks with periods**: When a sentence ends with a quotation mark, the period goes on the inside. The only exception to this rule in cases where the quotation marks are around text intended to be input by the user, but in these cases, use `code` formatting.
|
||||
|
||||
>The boy said, "The first time it said 'hello world,' I knew we would be friends."
|
||||
|
||||
>At the prompt, type `hello world`.
|
||||
|
||||
**Colons on sentences**: When a sentence proceeds and is describing or introducing a code block, list or example; use a colon.
|
||||
|
||||
Code block:
|
||||
|
||||
> To run the script, type:
|
||||
> ```bash
|
||||
> run hello-world
|
||||
> ```
|
||||
|
||||
List:
|
||||
|
||||
> It has said the following:
|
||||
> * hello world
|
||||
|
||||
Example:
|
||||
|
||||
> An example of how to format phrases it can say:
|
||||
> > Hello world
|
||||
> > Hello world!
|
||||
> > Hello world?
|
||||
|
||||
**Periods on sentences**: Except for a sentence proceeding a code block, list, or example; end all complete sentences with a period including sentences in code comments and list items.
|
||||
|
||||
Code comment:
|
||||
|
||||
> ```javascript
|
||||
> // Update this string to change what it will say.
|
||||
>
|
||||
> alert("hello world");
|
||||
> ```
|
||||
|
||||
List:
|
||||
|
||||
> Over the years, I have had a few say 'hello world' to me:
|
||||
> * The first was a CBM 8032 I received for my 12th birthday.
|
||||
|
||||
### Headings
|
||||
|
||||
**Page heading**: Start all pages with a level 1 heading.
|
||||
|
||||
Markdown:
|
||||
|
||||
```markdown
|
||||
# My first computer
|
||||
```
|
||||
|
||||
HTML:
|
||||
|
||||
```HTML
|
||||
<h1>My first computer</h1>
|
||||
```
|
||||
|
||||
**Sentence case headings**: Headings formatted in sentence case. The exception is proper names and acronyms that are capitalized.
|
||||
|
||||
*Heading in sentence case:*
|
||||
|
||||
> #### My first computer
|
||||
|
||||
*Heading with acronym:*
|
||||
|
||||
> #### My first CBM 8032
|
||||
|
||||
*Heading with proper name:*
|
||||
|
||||
> #### My first Commodore
|
||||
|
||||
**Punctuation on headings**: Do not put periods on headings and avoid headings that are questions or complete sentences.
|
||||
|
||||
### References
|
||||
|
||||
**HTML elements**: When referencing HTML elements, use the element syntax inside angle brackets with the word 'element' or 'elements' in context. Include a link to the MDN documentation for the element:
|
||||
|
||||
> Use an [`<a>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a) element for hypertext.
|
||||
|
||||
> The elements [`<b>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/b) and [`<strong>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/strong) are not equivalent.
|
||||
|
||||
**UI text**: When referencing text in a UI such as a name in a button or menu item, use **bold** formatting:
|
||||
|
||||
> Click the **submit** button.
|
||||
|
||||
**Named objects**: When referencing named objects such as other components or packages, use *italic* formatting with a descriptive word such as "component" in context:
|
||||
|
||||
> Use the *button* component.
|
||||
|
||||
**Code**: When referencing code, console commands, or file names; use `code` formatting:
|
||||
|
||||
> Type `npm start` in the console.
|
||||
|
||||
> Use the `fast-animation` package.
|
||||
|
||||
> The `console.log()` method outputs a message to the console.
|
||||
|
||||
### Markdown
|
||||
|
||||
**Element spacing**: Use one line break between markdown elements.
|
||||
|
||||
For example, between headings, paragraphs, code fences, and images:
|
||||
|
||||
```markdown
|
||||
# Heading 1
|
||||
|
||||
Paragraph
|
||||
|
||||
* List 1
|
||||
* List 2
|
||||
|
||||
## Heading 2
|
||||
|
||||
![Image](https://image.url)
|
||||
```
|
||||
|
||||
**Trailing space**: Remove trailing spaces at the end of elements and do not include an extra line break at the end of the markdown file.
|
||||
|
||||
**Unordered lists**: Use `*` syntax for un-ordered lists:
|
||||
|
||||
> ```markdown
|
||||
> Technologies used:
|
||||
>
|
||||
> * TypeScript
|
||||
> * React
|
||||
> * JSS
|
||||
> ```
|
||||
|
||||
### Code
|
||||
|
||||
**Code fence languages**: Provide a language for code fences:
|
||||
|
||||
Example CSS code fence:
|
||||
|
||||
````markdown
|
||||
```css
|
||||
.selector {
|
||||
background: white;
|
||||
}
|
||||
```
|
||||
````
|
||||
|
||||
You can find a list of supported languages [here](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
||||
|
||||
**Testing examples**: Test your code examples to verify they are working as expected.
|
||||
|
||||
**Code guidelines**: Verify that code examples follow the projects coding guidelines. For example, four spaces for indenting.
|
||||
|
||||
#### Code comments
|
||||
|
||||
Code comments can be fragments or complete sentences. Depending on the format, there are slightly different guidelines.
|
||||
|
||||
Code comments in **sentence** format:
|
||||
|
||||
* Can be formatted as a single line or multi-line syntax.
|
||||
* Have periods or question marks at the end.
|
||||
|
||||
Code comments in **fragment** format:
|
||||
|
||||
* Are formatted as single line syntax.
|
||||
* Do *not* have periods or question marks at the end.
|
||||
|
||||
[CMoS]: https://www.amazon.com/Chicago-Manual-Style-16th/dp/0226104206/ref=pd_lpo_sbs_14_t_0?_encoding=UTF8&psc=1&refRID=2QG7JEGM9PVNQJR5V00Y
|
||||
|
||||
[APS]: https://www.amazon.com/Associated-Press-Stylebook-2018-ebook-dp-B07DJBHCKP/dp/B07DJBHCKP/ref=mt_kindle?_encoding=UTF8&me=&qid=1546304954
|
||||
|
||||
[NGSM]: https://sites.google.com/a/ngs.org/ngs-style-manual/home/C/computer-terms
|
||||
|
||||
[GaOSG]: https://www.theguardian.com/guardian-observer-style-guide-a
|
||||
|
||||
[TBNS]: http://www2.media.uoa.gr/lectures/linguistic_archives/academic_papers0506/notes/stylesheets_3.pdf
|
|
@ -1,31 +0,0 @@
|
|||
---
|
||||
id: design-system
|
||||
title: Design system
|
||||
sidebar_label: Design system
|
||||
---
|
||||
|
||||
# Design System
|
||||
|
||||
## Working with the design system provider
|
||||
The `DesignSystemProvider` is a React component that provides, via [React context](https://reactjs.org/docs/context.html), the *design-system* object to descendent context consumers.
|
||||
|
||||
It accepts a `designSystem` property:
|
||||
```jsx
|
||||
<DesignSystemProvider designSystem={{backgroundColor: "#FFF"}}>
|
||||
/* children */
|
||||
</DesignSystemProvider>
|
||||
```
|
||||
|
||||
The `DesignSystemProvider` is designed to apply scoped changes to the *design-system* object, so it will merge the applied *design-system* with any upstream *design-system* object:
|
||||
|
||||
```jsx
|
||||
<DesignSystemProvider designSystem={{backgroundColor: "#FFF", density: 3}}>
|
||||
/* Stylesheet generated with {backgroundColor: "#FFF", density: 3} */
|
||||
<StyledButton>I'm a styled button</StyledButton>
|
||||
|
||||
<DesignSystemProvider designSystem={{backgroundColor: "#AAA"}>
|
||||
/* Stylesheet generated with {backgroundColor: "#AAA", density: 3} */
|
||||
<StyledButton>I'm another styled button</StyledButton>
|
||||
</DesignSystemProvider>
|
||||
</DesignSystemProvider>
|
||||
```
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
id: jss
|
||||
title: JSS (JavaScript Style Sheets)
|
||||
sidebar_label: JSS (JavaScript Style Sheets)
|
||||
---
|
||||
|
||||
# Working with JSS
|
||||
For info on how to write JSS stylesheets, visit [https://cssinjs.org/jss-syntax?v=v10.0.0](https://cssinjs.org/jss-syntax?v=v10.0.0)
|
||||
|
||||
## Accessing the design system in JSS
|
||||
The `JSSManager` allows us to access the current contextual design system by assigning a function value to a JSS rule. The only argument to this callback will be the current design system. For more information on the providing a design system object to the styles, see the documentation for [fast-jss-manager-react](https://www.fast.design/docs/en/packages/fast-jss-manager-react/).
|
||||
|
||||
```js
|
||||
// This code assumes a property `backgroundProperty` exists on the design system
|
||||
const styles = {
|
||||
button: {
|
||||
backgroundColor: (designSystem) => designSystem.backgroundColor
|
||||
}
|
||||
}
|
||||
```
|
|
@ -1,67 +0,0 @@
|
|||
---
|
||||
id: modifying-components
|
||||
title: Modifying components
|
||||
sidebar_label: Modifying components
|
||||
---
|
||||
|
||||
# Modifying components
|
||||
|
||||
## Using Props
|
||||
<!-- Basic details about what props are and our principle on delivering stateless components. Consider linking off to React documentation here. -->
|
||||
Each component will have its own set of [props](https://reactjs.org/docs/components-and-props.html#rendering-a-component) corresponding to the functionality needed for that component.
|
||||
|
||||
```jsx
|
||||
<AccentButton disabled={true}>
|
||||
Hello World
|
||||
</AccentButton>
|
||||
```
|
||||
## Unhandled props
|
||||
FAST components implement a model of props know as *handled* and *unhandled* props. *Handled* props can be thought of as first-class props explicitly used or expected by the component. *Unhandled* props are all other props. In general, all *unhandled* props will be passed along to the root element of the component, and are generally used to address instance accessibility requirements, custom event listeners, and add telemetry meta-data.
|
||||
|
||||
```jsx
|
||||
/*
|
||||
* aria-label is an unhandled prop, so it gets
|
||||
* applied to the root of the Button component
|
||||
*/
|
||||
<AccentButton aria-label={"Custom accessible label"}>
|
||||
Hello world
|
||||
</AccentButton>
|
||||
```
|
||||
|
||||
## Changing style
|
||||
|
||||
### Using classes
|
||||
```jsx
|
||||
<AccentButton
|
||||
className={"my-custom-class"}
|
||||
>
|
||||
Hello World
|
||||
</AccentButton>
|
||||
```
|
||||
|
||||
### Using props
|
||||
Instance style overrides can be applied using the `jssStyleSheet` property and targetting properties of the [class-name contract](#class-name-contracts).
|
||||
|
||||
```jsx
|
||||
let styles = {
|
||||
button: {
|
||||
margin: "0 auto"
|
||||
}
|
||||
};
|
||||
|
||||
<AccentButton
|
||||
jssStyleSheet={styles}
|
||||
>
|
||||
Hello World
|
||||
</AccentButton>
|
||||
```
|
||||
|
||||
### Using inline-styles
|
||||
Additionally, you can always use inline-styles. This will be treated as a *unhandled* prop and
|
||||
applied to the root element of the component.
|
||||
|
||||
```jsx
|
||||
<AccentButton style={{margin: "0 auto"}}>
|
||||
Hello World
|
||||
</AccentButton>
|
||||
```
|
|
@ -1,68 +0,0 @@
|
|||
---
|
||||
id: the-basics
|
||||
title: The basics
|
||||
sidebar_label: The basics
|
||||
---
|
||||
|
||||
# The basics
|
||||
|
||||
This document assumes a basic understanding of React. If you're unfamiliar, please read [React's getting started](https://reactjs.org/docs/getting-started.html) documentation first.
|
||||
|
||||
## Add a component to your page
|
||||
<!-- Cross-link to package specific documentation regarding installation instructions?-->
|
||||
|
||||
An easy way to get started with FAST styled components is the `@microsoft/fast-components-react-msft` package which conforms to Microsoft style guidance.
|
||||
|
||||
To use a styled component, simply import it from the package:
|
||||
|
||||
```jsx
|
||||
import { AccentButton } from "@microsoft/fast-components-react-msft";
|
||||
```
|
||||
And add the component to your markup:
|
||||
```jsx
|
||||
function render() {
|
||||
return <AccentButton>Hello world</AccentButton>
|
||||
}
|
||||
```
|
||||
|
||||
A full list of these components and their documentation can be found [here](https://explore.fast.design/).
|
||||
|
||||
---
|
||||
|
||||
## Core concepts
|
||||
|
||||
### Base components
|
||||
At the heart of the FAST component system are *base* components. *Base* components are general purpose, unstyled React components designed to meet semantic and accessability requirements for common UI patterns. In general, *base* components implement [*roles*](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques) from the ARIA specification.
|
||||
|
||||
### Styled components
|
||||
Styled components are implementations of the base components coupled with CSS styles to achieve visual design requirements. These can either be a simple styling layer over the *base* component, or components that extend *base* components with additional functionality or convenience features. These components tend to be more opinionated due the the nature of design implementation.
|
||||
|
||||
### Class name contracts
|
||||
Each base component implements a *class-name contract* - an enumeration and implementation of all classes used by the component. Simple components such as `Hyperlink` may only expose a single class name in the *class-name contract*. More complicated components such as `Breadcrumb` will have multiple class names and will apply them to the appropriate elements. For instance, the `Breadcrumb` component implements the following *class-name contract*:
|
||||
|
||||
```typescript
|
||||
interface BreadcrumbClassNameContract {
|
||||
breadcrumb: string; // Applied to the root of the component
|
||||
breadcrumb_item: string; // Applied to each breadcrumb item
|
||||
breadcrumb_item__current: string; // Applied to the item representing the location in the breadcrumb
|
||||
breadcrumb_itemsContainer: string; // Applied to the container of all the breadcrumb items
|
||||
breadcrumb_separator: string; // Applied to the element representing the separator of the breadcrumb items
|
||||
}
|
||||
```
|
||||
|
||||
When the base component renders, it will apply classes to elements from the *class-name contract* properties of the `managedClasses` prop:
|
||||
|
||||
```jsx
|
||||
// Inside the Breadcrumb render function
|
||||
<div className={props.managedClasses.breadcrumb}>
|
||||
<div className={props.managedClasses.breadcrum_itemsContainer}>
|
||||
/* ...etc */
|
||||
</div>
|
||||
</div>
|
||||
```
|
||||
|
||||
#### How are components styled?
|
||||
Base components are styled using [JSS](https://cssinjs.org/?v=v10.0.0) - a tool for generating stylesheets from JavaScript objects. Each JSS stylesheet conforms the the class-name contract defined by the component. [@microsoft/fast-jss-manager-react](https://github.com/microsoft/fast/tree/master/packages/fast-jss-manager-react) is used to compose a component stylesheet with a base component, and will manage CSS creation, update, and removal processes during the component lifecycle.
|
||||
|
||||
#### What is the design system?
|
||||
The *design-system* is all of the design data - it captures design thinking into a configuration object that informs components how to render. This can include information about color, font-weights, UI density, motion, and more. In practice, this object is provided to JSS stylesheets so that the resulting CSS is a product of the *design-system*.
|
|
@ -1,10 +0,0 @@
|
|||
---
|
||||
id: utilities
|
||||
title: Utilities
|
||||
sidebar_label: Utilities
|
||||
---
|
||||
|
||||
# Utilities
|
||||
FAST has two utility libraries for common operations:
|
||||
1. <a href="https://github.com/microsoft/fast/tree/master/packages/fast-web-utilities" target="_blank">@microsoft/fast-web-utilities</a> contains general-purpose JavaScript utilities
|
||||
2. <a href="https://github.com/microsoft/fast/tree/master/packages/fast-jss-utilities" target="_blank">@microsoft/fast-jss-utilities</a> are utilities intended to be used in JSS stylesheets
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
id: readme
|
||||
title: FAST
|
||||
sidebar_label: What is FAST
|
||||
---
|
||||
|
||||
# FAST
|
||||
|
||||
An unopinionated system of components, development tools, and utilities used à la carte or as a suite to build enterprise-grade websites and applications.
|
||||
|
||||
## Key features & benefits
|
||||
|
||||
### Unopinionated
|
||||
|
||||
These days, there are a million and one great ways to build your next Web site or application. So, we have made being unopinionated the center of every decision made in FAST.
|
||||
|
||||
This principle of being unopinionated manifests in several important ways including:
|
||||
|
||||
* A flat component architecture that lets you compose what you need without struggling with rigid patterns and complex objects.
|
||||
* Separating base components and style that supports multiple frameworks without re-writing or duplicating styles. This separation also lets you build your own styles, with your style technology of choice, without having to re-build or duplicate the base components.
|
||||
* Framework agnostic tooling that lets you use our Development tools with any view framework.
|
||||
* The ability to replace almost any FAST package with your package of choice. Get started with our animation or layout package and add more as you need them. Alternatively, use our suite of packages to build your next project from the ground up; it's your call.
|
||||
|
||||
### UI development and style guide tools
|
||||
|
||||
When developing components and views, excellent development tooling can make all the difference. FAST offers development and style guide tools that work with FAST components, components from other frameworks or your components.
|
||||
|
||||
Try out component properties with an auto-generated props UI, get a live preview of the code based on any property’s configuration, preview RTL and themes, and preview component compositing with a transparency grid.
|
||||
|
||||
Also, we built FAST development tools from re-usable packages so, if you have special needs, you can build your tools from the same shared libraries.
|
||||
|
||||
### Bring your design system
|
||||
|
||||
Widely available design systems from companies like Microsoft (Fluent), Google (Material), or Salesforce (Lightning) are useful when it is essential to align with a platform or take advantage of a polished system at low cost, but many companies have their design system of their own, and some may have multiple design systems or variations.
|
||||
|
||||
Because FAST has abstracted based components from their style, you get a head start on your design system by building on top of tried and true base components and style libraries like our offerings for color, animation, and elevation.
|
|
@ -20,11 +20,6 @@
|
|||
"url": "https://github.com/Microsoft/fast/issues/new/choose"
|
||||
},
|
||||
"scripts": {
|
||||
"docs:build": "node build/documentation/generate-typedocs.js",
|
||||
"docs:build:api": "node build/documentation/generate-typedocs.js",
|
||||
"docs:build:dry-run": "node build/documentation/generate-typedocs.js --dry-run",
|
||||
"docs:build:readme": "node build/documentation/copy-package-readme.js",
|
||||
"docs:build:verbose": "node build/documentation/generate-typedocs.js --verbose",
|
||||
"integration-tests:alpha": "node build/testing/sauce-labs/test-browsers.js alpha",
|
||||
"integration-tests:beta": "node build/testing/sauce-labs/test-browsers.js beta",
|
||||
"integration-tests:release": "node build/testing/sauce-labs/test-browsers.js release",
|
||||
|
|
|
@ -4,5 +4,4 @@ FAST is organized as a monorepo and this is where you'll find the packages we pu
|
|||
|
||||
* `web-components` - Packages that are directly related to web component technologies. This includes tech for building components, our components library, and our design system implementations.
|
||||
* `utilities` - General purpose packages useful in creating web apps and sites. This includes tech for colors, animation, linting, etc.
|
||||
* `tooling` - Packages that contain design and prototyping tools.
|
||||
* `react` - Legacy React components that predate the modern web component work.
|
||||
* `tooling` - Packages that contain design and prototyping tools.
|
|
@ -1,6 +0,0 @@
|
|||
# don't ever lint node_modules
|
||||
node_modules
|
||||
# don't lint build output (make sure it's set to your correct build folder name)
|
||||
dist
|
||||
# don't lint coverage output
|
||||
coverage
|
|
@ -1,3 +0,0 @@
|
|||
module.exports = {
|
||||
extends: ["@microsoft/eslint-config-fast-dna", "prettier"],
|
||||
};
|
|
@ -1,5 +0,0 @@
|
|||
# Source files
|
||||
src/
|
||||
|
||||
# Configs
|
||||
tsconfig.json
|
|
@ -1 +0,0 @@
|
|||
package-lock=false
|
|
@ -1,3 +0,0 @@
|
|||
coverage/*
|
||||
dist/*
|
||||
www/*
|
|
@ -1,499 +0,0 @@
|
|||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [4.8.0](https://github.com/microsoft/fast-react/compare/@microsoft/fast-components-class-name-contracts-base@4.7.3...@microsoft/fast-components-class-name-contracts-base@4.8.0) (2020-07-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update repo URL to be the soon-to-be archived repo for React packages ([#3498](https://github.com/microsoft/fast-react/issues/3498)) ([693d7fd](https://github.com/microsoft/fast-react/commit/693d7fd70823fbc9cc13d502764dbef8faf27e6f))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update typescript version and remove utility types dependencies for react packages ([#3422](https://github.com/microsoft/fast-react/issues/3422)) ([09d07b5](https://github.com/microsoft/fast-react/commit/09d07b580cda3bcc5d28f83d3568521f710c9576))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.3](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.7.2...@microsoft/fast-components-class-name-contracts-base@4.7.3) (2020-06-26)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.7.1...@microsoft/fast-components-class-name-contracts-base@4.7.2) (2020-06-15)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* react datagrid - don't unnecessarily hardcode layout panel ([#3285](https://github.com/Microsoft/fast/issues/3285)) ([c3678f6](https://github.com/Microsoft/fast/commit/c3678f684c09145d194367153c6839280f33730a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.7.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.6.5...@microsoft/fast-components-class-name-contracts-base@4.7.0) (2020-06-05)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add data grid to base React component set ([#3158](https://github.com/Microsoft/fast/issues/3158)) ([d2e7ead](https://github.com/Microsoft/fast/commit/d2e7ead60e7973cead222843899829f879b67da0))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.6.5](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.6.4...@microsoft/fast-components-class-name-contracts-base@4.6.5) (2020-05-18)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.6.4](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.6.3...@microsoft/fast-components-class-name-contracts-base@4.6.4) (2020-04-22)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.6.3](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.6.2...@microsoft/fast-components-class-name-contracts-base@4.6.3) (2020-04-10)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.6.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.6.1...@microsoft/fast-components-class-name-contracts-base@4.6.2) (2020-03-13)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.6.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.6.0...@microsoft/fast-components-class-name-contracts-base@4.6.1) (2020-02-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* select - add css class for scaleToFit mode ([#2626](https://github.com/Microsoft/fast/issues/2626)) ([15c7a50](https://github.com/Microsoft/fast/commit/15c7a50ef336e4531261ce1fe6be3695c9533243))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.6.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.5.0...@microsoft/fast-components-class-name-contracts-base@4.6.0) (2019-12-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add tree view as a new component ([#2510](https://github.com/Microsoft/fast/issues/2510)) ([1a1d465](https://github.com/Microsoft/fast/commit/1a1d46566dc6c378a0f1981341a36dcb9897226f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.5.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.4.0...@microsoft/fast-components-class-name-contracts-base@4.5.0) (2019-11-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* select class and style support for scaling menus ([#2397](https://github.com/Microsoft/fast/issues/2397)) ([d9b4c84](https://github.com/Microsoft/fast/commit/d9b4c841e38dcf837f0159cf9928cceda0bb9de8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.4.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.3.3...@microsoft/fast-components-class-name-contracts-base@4.4.0) (2019-10-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add viewport positioner to select menu ([#2263](https://github.com/Microsoft/fast/issues/2263)) ([af5f04a](https://github.com/Microsoft/fast/commit/af5f04a))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.3.3](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.3.2...@microsoft/fast-components-class-name-contracts-base@4.3.3) (2019-09-10)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* Enable slider touch dragging ([#2213](https://github.com/Microsoft/fast/issues/2213)) ([70983fa](https://github.com/Microsoft/fast/commit/70983fa))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.3.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.3.1...@microsoft/fast-components-class-name-contracts-base@4.3.2) (2019-09-05)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* improve slider thumb animations ([#2187](https://github.com/Microsoft/fast/issues/2187)) ([71ffcd8](https://github.com/Microsoft/fast/commit/71ffcd8))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.3.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.3.0...@microsoft/fast-components-class-name-contracts-base@4.3.1) (2019-08-22)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.3.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.2.0...@microsoft/fast-components-class-name-contracts-base@4.3.0) (2019-06-25)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add new components for each button appearance style ([#1865](https://github.com/Microsoft/fast/issues/1865)) ([b64d29c](https://github.com/Microsoft/fast/commit/b64d29c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.2.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.1.1...@microsoft/fast-components-class-name-contracts-base@4.2.0) (2019-06-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add viewport positioner component ([#1781](https://github.com/Microsoft/fast/issues/1781)) ([a45dda6](https://github.com/Microsoft/fast/commit/a45dda6))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.1.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.1.0...@microsoft/fast-components-class-name-contracts-base@4.1.1) (2019-05-31)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.1.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.0.1...@microsoft/fast-components-class-name-contracts-base@4.1.0) (2019-04-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add slider component ([#1676](https://github.com/Microsoft/fast/issues/1676)) ([6eded38](https://github.com/Microsoft/fast/commit/6eded38))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.0.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@4.0.0...@microsoft/fast-components-class-name-contracts-base@4.0.1) (2019-04-09)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-base
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.0.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.10.0...@microsoft/fast-components-class-name-contracts-base@4.0.0) (2019-03-25)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update to use esModuleInterop in the TypeScript configuration files ([#1211](https://github.com/Microsoft/fast/issues/1211)) ([2ec0644](https://github.com/Microsoft/fast/commit/2ec0644))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* This will affect how imports will be handled by
|
||||
consumers
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.10.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.9.0...@microsoft/fast-components-class-name-contracts-base@3.10.0) (2019-03-19)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add auto suggest component ([#1551](https://github.com/Microsoft/fast/issues/1551)) ([660fc41](https://github.com/Microsoft/fast/commit/660fc41))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.9.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.8.0...@microsoft/fast-components-class-name-contracts-base@3.9.0) (2019-03-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add base select component ([#1422](https://github.com/Microsoft/fast/issues/1422)) ([b77a25e](https://github.com/Microsoft/fast/commit/b77a25e))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.8.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.7.0...@microsoft/fast-components-class-name-contracts-base@3.8.0) (2019-02-28)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add additional wrapper to dialog to prevent subpixel aliasing due to css transforms ([#1431](https://github.com/Microsoft/fast/issues/1431)) ([1fad8fe](https://github.com/Microsoft/fast/commit/1fad8fe))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add class name for horizontal overflow items ([#1448](https://github.com/Microsoft/fast/issues/1448)) ([ffb6d87](https://github.com/Microsoft/fast/commit/ffb6d87))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.7.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.6.0...@microsoft/fast-components-class-name-contracts-base@3.7.0) (2019-02-21)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add additional functionality to listbox base ([#1381](https://github.com/Microsoft/fast/issues/1381)) ([48d9c31](https://github.com/Microsoft/fast/commit/48d9c31))
|
||||
* create number field as base and MSFT component ([#1371](https://github.com/Microsoft/fast/issues/1371)) ([d440b5f](https://github.com/Microsoft/fast/commit/d440b5f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.6.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.5.0...@microsoft/fast-components-class-name-contracts-base@3.6.0) (2019-02-07)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* child component class name assignment in tabs ([#1345](https://github.com/Microsoft/fast/issues/1345)) ([769aa2b](https://github.com/Microsoft/fast/commit/769aa2b))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add badge as an MSFT component ([#1278](https://github.com/Microsoft/fast/issues/1278)) ([79ce26c](https://github.com/Microsoft/fast/commit/79ce26c))
|
||||
* add listbox base component ([#1304](https://github.com/Microsoft/fast/issues/1304)) ([0ad4cbe](https://github.com/Microsoft/fast/commit/0ad4cbe))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.5.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.4.0...@microsoft/fast-components-class-name-contracts-base@3.5.0) (2019-01-15)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add text area as a new component ([#1267](https://github.com/Microsoft/fast/issues/1267)) ([0bdd43f](https://github.com/Microsoft/fast/commit/0bdd43f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.4.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.3.1...@microsoft/fast-components-class-name-contracts-base@3.4.0) (2018-12-31)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add support for render props to tabs ([#1199](https://github.com/Microsoft/fast/issues/1199)) ([19f482e](https://github.com/Microsoft/fast/commit/19f482e))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="3.3.1"></a>
|
||||
## [3.3.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-base@3.3.0...@microsoft/fast-components-class-name-contracts-base@3.3.1) (2018-12-21)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* style cleanup and consolidation ([#1198](https://github.com/Microsoft/fast/issues/1198)) ([4151f39](https://github.com/Microsoft/fast/commit/4151f39))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.2.0"></a>
|
||||
# 2.2.0 (2018-09-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add contrast based color system ([#810](https://github.com/Microsoft/fast/issues/810)) ([5ec457c](https://github.com/Microsoft/fast/commit/5ec457c))
|
||||
* **progress:** add progress component ([#835](https://github.com/Microsoft/fast/issues/835)) ([44d9bb1](https://github.com/Microsoft/fast/commit/44d9bb1))
|
||||
|
||||
|
||||
|
||||
<a name="2.1.0"></a>
|
||||
# 2.1.0 (2018-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update Lerna to ^3.0.0 ([#795](https://github.com/Microsoft/fast/issues/795)) ([9ce9a56](https://github.com/Microsoft/fast/commit/9ce9a56))
|
||||
* upgrade to TypeScript 3.0.0 ([#793](https://github.com/Microsoft/fast/issues/793)) ([e203e86](https://github.com/Microsoft/fast/commit/e203e86))
|
||||
* **fast-components-react-base:** add callback to horizontal overflow to return and object that informs scroll start and end ([#797](https://github.com/Microsoft/fast/issues/797)) ([37975f3](https://github.com/Microsoft/fast/commit/37975f3))
|
||||
* **fast-components-react-base:** add tabs component ([#761](https://github.com/Microsoft/fast/issues/761)) ([24a5bb3](https://github.com/Microsoft/fast/commit/24a5bb3))
|
||||
|
||||
|
||||
|
||||
<a name="2.0.0-corrected"></a>
|
||||
# 2.0.0-corrected (2018-08-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* travis-CI build-break ([#336](https://github.com/Microsoft/fast/issues/336)) ([bffbf5e](https://github.com/Microsoft/fast/commit/bffbf5e))
|
||||
* **fast-components-react-msft:** fixes error running jest with components that require chroma ([#687](https://github.com/Microsoft/fast/issues/687)) ([140457c](https://github.com/Microsoft/fast/commit/140457c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add hypertext component ([#210](https://github.com/Microsoft/fast/issues/210)) ([9e363ff](https://github.com/Microsoft/fast/commit/9e363ff))
|
||||
* **checkbox:** update styling and incorrect states ([#371](https://github.com/Microsoft/fast/issues/371)) ([45cbe3c](https://github.com/Microsoft/fast/commit/45cbe3c))
|
||||
* Forked Class name contracts so we can have one for Base and one for MSFT ([#262](https://github.com/Microsoft/fast/issues/262)) ([a4c54c0](https://github.com/Microsoft/fast/commit/a4c54c0))
|
||||
* **checkbox:** add new component with styles ([#252](https://github.com/Microsoft/fast/issues/252)) ([3ad3988](https://github.com/Microsoft/fast/commit/3ad3988))
|
||||
* update code coverage on travis ([#330](https://github.com/Microsoft/fast/issues/330)) ([63ab4f4](https://github.com/Microsoft/fast/commit/63ab4f4))
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
* **dialog:** add dialog as a new component ([#752](https://github.com/Microsoft/fast/issues/752)) ([2864021](https://github.com/Microsoft/fast/commit/2864021))
|
||||
* **fast-components-react-base:** add horizontal overflow ([#739](https://github.com/Microsoft/fast/issues/739)) ([c6b0ebf](https://github.com/Microsoft/fast/commit/c6b0ebf))
|
||||
* **fast-css-editor-react:** add default editor component and position component ([#636](https://github.com/Microsoft/fast/issues/636)) ([72037a8](https://github.com/Microsoft/fast/commit/72037a8))
|
||||
* **form generator:** updates styles found in configuration pane ([#420](https://github.com/Microsoft/fast/issues/420)) ([919121b](https://github.com/Microsoft/fast/commit/919121b))
|
||||
* **label:** add new component and msft styles ([#265](https://github.com/Microsoft/fast/issues/265)) ([0328028](https://github.com/Microsoft/fast/commit/0328028))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.1.0"></a>
|
||||
# [2.1.0](https://github.com/Microsoft/fast/compare/v2.0.0-corrected...v2.1.0) (2018-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update Lerna to ^3.0.0 ([#795](https://github.com/Microsoft/fast/issues/795)) ([9ce9a56](https://github.com/Microsoft/fast/commit/9ce9a56))
|
||||
* upgrade to TypeScript 3.0.0 ([#793](https://github.com/Microsoft/fast/issues/793)) ([e203e86](https://github.com/Microsoft/fast/commit/e203e86))
|
||||
* **fast-components-react-base:** add callback to horizontal overflow to return and object that informs scroll start and end ([#797](https://github.com/Microsoft/fast/issues/797)) ([37975f3](https://github.com/Microsoft/fast/commit/37975f3))
|
||||
* **fast-components-react-base:** add tabs component ([#761](https://github.com/Microsoft/fast/issues/761)) ([24a5bb3](https://github.com/Microsoft/fast/commit/24a5bb3))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.0.0"></a>
|
||||
# [2.0.0](https://github.com/Microsoft/fast/compare/v1.6.0...v2.0.0) (2018-08-02)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **fast-components-react-msft:** fixes error running jest with components that require chroma ([#687](https://github.com/Microsoft/fast/issues/687)) ([140457c](https://github.com/Microsoft/fast/commit/140457c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
* **dialog:** add dialog as a new component ([#752](https://github.com/Microsoft/fast/issues/752)) ([2864021](https://github.com/Microsoft/fast/commit/2864021))
|
||||
* **fast-components-react-base:** add horizontal overflow ([#739](https://github.com/Microsoft/fast/issues/739)) ([c6b0ebf](https://github.com/Microsoft/fast/commit/c6b0ebf))
|
||||
* **fast-css-editor-react:** add default editor component and position component ([#636](https://github.com/Microsoft/fast/issues/636)) ([72037a8](https://github.com/Microsoft/fast/commit/72037a8))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.9.0"></a>
|
||||
# [1.9.0](https://github.com/Microsoft/fast/compare/v1.6.0...v1.9.0) (2018-07-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **fast-components-react-msft:** fixes error running jest with components that require chroma ([#687](https://github.com/Microsoft/fast/issues/687)) ([140457c](https://github.com/Microsoft/fast/commit/140457c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
* **fast-css-editor-react:** add default editor component and position component ([#636](https://github.com/Microsoft/fast/issues/636)) ([72037a8](https://github.com/Microsoft/fast/commit/72037a8))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.8.0"></a>
|
||||
# [1.8.0](https://github.com/Microsoft/fast/compare/v1.6.0...v1.8.0) (2018-06-12)
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.7.0"></a>
|
||||
# [1.7.0](https://github.com/Microsoft/fast/compare/v1.6.0...v1.7.0) (2018-06-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.6.0"></a>
|
||||
# [1.6.0](https://github.com/Microsoft/fast/compare/v1.2.0...v1.6.0) (2018-05-16)
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.5.0"></a>
|
||||
# [1.5.0](https://github.com/Microsoft/fast/compare/v1.2.0...v1.5.0) (2018-05-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **form generator:** updates styles found in configuration pane ([#420](https://github.com/Microsoft/fast/issues/420)) ([919121b](https://github.com/Microsoft/fast/commit/919121b))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.4.0"></a>
|
||||
# [1.4.0](https://github.com/Microsoft/fast/compare/v1.2.0...v1.4.0) (2018-05-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **form generator:** updates styles found in configuration pane ([#420](https://github.com/Microsoft/fast/issues/420)) ([919121b](https://github.com/Microsoft/fast/commit/919121b))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.2.0"></a>
|
||||
# 1.2.0 (2018-05-10)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **checkbox:** update styling and incorrect states ([#371](https://github.com/Microsoft/fast/issues/371)) ([45cbe3c](https://github.com/Microsoft/fast/commit/45cbe3c))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.1.0"></a>
|
||||
# 1.1.0 (2018-05-09)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* travis-CI build-break ([#336](https://github.com/Microsoft/fast/issues/336)) ([bffbf5e](https://github.com/Microsoft/fast/commit/bffbf5e))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add hypertext component ([#210](https://github.com/Microsoft/fast/issues/210)) ([9e363ff](https://github.com/Microsoft/fast/commit/9e363ff))
|
||||
* Forked Class name contracts so we can have one for Base and one for MSFT ([#262](https://github.com/Microsoft/fast/issues/262)) ([a4c54c0](https://github.com/Microsoft/fast/commit/a4c54c0))
|
||||
* **checkbox:** add new component with styles ([#252](https://github.com/Microsoft/fast/issues/252)) ([3ad3988](https://github.com/Microsoft/fast/commit/3ad3988))
|
||||
* **label:** add new component and msft styles ([#265](https://github.com/Microsoft/fast/issues/265)) ([0328028](https://github.com/Microsoft/fast/commit/0328028))
|
||||
* update code coverage on travis ([#330](https://github.com/Microsoft/fast/issues/330)) ([63ab4f4](https://github.com/Microsoft/fast/commit/63ab4f4))
|
|
@ -1,27 +0,0 @@
|
|||
# FAST Components class name contracts base
|
||||
|
||||
This package provides the TypeScript typings for all FAST components class-name contracts. These contracts enable strict typing of JSS stylesheets and each component's expectation of which class-names will be made available (and under which keys those class-names reside) to the component at runtime.
|
||||
|
||||
## A deeper dive
|
||||
|
||||
FAST base components are built from the ground-up to work with CSS module implementations. This means that each HTML `class` attribute can be dynamic and unique. To facilitate working with any CSS module implementation, each component expects as a data the `class` attribute values when the component is instantiated.
|
||||
|
||||
These contracts simply describe - as TypeScript interfaces - the key/value pairs that each component can expect to be able to use when retrieving these dynamic class-names.
|
||||
|
||||
```tsx
|
||||
inteface ButtonClassNameContract {
|
||||
button: string;
|
||||
}
|
||||
|
||||
// In the button base-component, we use the class-name contract to inform which keys will available on the
|
||||
// `managedClasses` object, which is where dynamic class-names get added as props to a component.
|
||||
render(): JSX.Element {
|
||||
return (
|
||||
<button className={this.props.managedClasses.button}>{this.props.children}</button>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## TypeScript only
|
||||
|
||||
This package only contains TypeScript interfaces to be used by other packages - as such, it will get completely compiled out of your project during your build to JavaScript. If you're not using TypeScript, this package will have no effect on your codebase.
|
|
@ -1,37 +0,0 @@
|
|||
{
|
||||
"name": "@microsoft/fast-components-class-name-contracts-base",
|
||||
"description": "Type descriptions for the classnames that any given component can expect as props.",
|
||||
"sideEffects": false,
|
||||
"version": "4.8.0",
|
||||
"author": {
|
||||
"name": "Microsoft",
|
||||
"url": "https://discord.gg/FcSNfg4"
|
||||
},
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/microsoft/fast-react.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/Microsoft/fast/issues/new/choose"
|
||||
},
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"scripts": {
|
||||
"build": "tsc -p ./tsconfig.build.json",
|
||||
"clean:dist": "node ../../../build/clean.js dist",
|
||||
"prepare": "yarn clean:dist && yarn build",
|
||||
"prettier": "prettier --config ../../../.prettierrc --write \"**/*.ts\"",
|
||||
"prettier:diff": "prettier --config ../../../.prettierrc \"**/*.ts\" --list-different",
|
||||
"test": "yarn eslint",
|
||||
"eslint": "eslint . --ext .ts,.tsx",
|
||||
"eslint:fix": "eslint . --ext .ts,.tsx --fix",
|
||||
"watch": "yarn build -- -w --preserveWatchOutput"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@microsoft/eslint-config-fast-dna": "^1.2.0",
|
||||
"eslint-config-prettier": "^6.10.1",
|
||||
"prettier": "2.0.2",
|
||||
"typescript": "^3.9.0"
|
||||
}
|
||||
}
|
|
@ -1,24 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the auto suggest component
|
||||
*/
|
||||
export interface AutoSuggestClassNameContract {
|
||||
/**
|
||||
* The root of the auto suggest component
|
||||
*/
|
||||
autoSuggest?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
autoSuggest__disabled?: string;
|
||||
|
||||
/**
|
||||
* The menu of the auto suggest component
|
||||
*/
|
||||
autoSuggest_menu?: string;
|
||||
|
||||
/**
|
||||
* The menu open modifier
|
||||
*/
|
||||
autoSuggest__menuOpen?: string;
|
||||
}
|
|
@ -1,6 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the badge component
|
||||
*/
|
||||
export interface BadgeClassNameContract {
|
||||
badge?: string;
|
||||
}
|
|
@ -1,10 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the breadcrumb component
|
||||
*/
|
||||
export interface BreadcrumbClassNameContract {
|
||||
breadcrumb?: string;
|
||||
breadcrumb_item?: string;
|
||||
breadcrumb_item__current?: string;
|
||||
breadcrumb_itemsContainer?: string;
|
||||
breadcrumb_separator?: string;
|
||||
}
|
|
@ -1,14 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the button component
|
||||
*/
|
||||
export interface ButtonClassNameContract {
|
||||
/**
|
||||
* The root of the button component
|
||||
*/
|
||||
button?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
button__disabled?: string;
|
||||
}
|
|
@ -1,6 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the card component
|
||||
*/
|
||||
export interface CardClassNameContract {
|
||||
card?: string;
|
||||
}
|
|
@ -1,39 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the checkbox component
|
||||
*/
|
||||
export interface CheckboxClassNameContract {
|
||||
/**
|
||||
* The root of the checkbox component
|
||||
*/
|
||||
checkbox?: string;
|
||||
|
||||
/**
|
||||
* The checkbox input element
|
||||
*/
|
||||
checkbox_input?: string;
|
||||
|
||||
/**
|
||||
* The label associated with the checkbox
|
||||
*/
|
||||
checkbox_label?: string;
|
||||
|
||||
/**
|
||||
* The checkbox state indicator
|
||||
*/
|
||||
checkbox_stateIndicator?: string;
|
||||
|
||||
/**
|
||||
* The disabled state modifier
|
||||
*/
|
||||
checkbox__disabled?: string;
|
||||
|
||||
/**
|
||||
* The checked state modifier
|
||||
*/
|
||||
checkbox__checked?: string;
|
||||
|
||||
/**
|
||||
* The indeterminate state modifer
|
||||
*/
|
||||
checkbox__indeterminate?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the context-menu-item component
|
||||
*/
|
||||
export interface ContextMenuItemClassNameContract {
|
||||
contextMenuItem?: string;
|
||||
contextMenuItem__checkbox?: string;
|
||||
contextMenuItem__radio?: string;
|
||||
contextMenuItem__disabled?: string;
|
||||
}
|
|
@ -1,6 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the context-menu component
|
||||
*/
|
||||
export interface ContextMenuClassNameContract {
|
||||
contextMenu?: string;
|
||||
}
|
|
@ -1,64 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the data grid component
|
||||
*/
|
||||
export interface DataGridClassNameContract {
|
||||
/**
|
||||
* The root of the data grid component
|
||||
*/
|
||||
dataGrid?: string;
|
||||
|
||||
/**
|
||||
* Applied if the datagrid virtualize prop is true
|
||||
*/
|
||||
dataGrid__virtualized?: string;
|
||||
|
||||
/**
|
||||
* The scrolling container
|
||||
*/
|
||||
dataGrid_scrollingPanel?: string;
|
||||
|
||||
/**
|
||||
* the container that contains the data grid rows
|
||||
*/
|
||||
dataGrid_scrollingPanelItems?: string;
|
||||
|
||||
/**
|
||||
* Applied if the scrolling panel has enough items to be scrollable
|
||||
*/
|
||||
dataGrid_scrollingPanel__scrollable?: string;
|
||||
|
||||
/**
|
||||
* The header of the data grid component
|
||||
*/
|
||||
dataGrid_header?: string;
|
||||
|
||||
/**
|
||||
* The column header of the data grid component
|
||||
*/
|
||||
dataGrid_columnHeader?: string;
|
||||
|
||||
/**
|
||||
* The rows of the data grid component
|
||||
*/
|
||||
dataGrid_row?: string;
|
||||
|
||||
/**
|
||||
* Applied when focus is in a particular row
|
||||
*/
|
||||
dataGrid_row__focusedWithin?: string;
|
||||
|
||||
/**
|
||||
* A cell within the data grid component
|
||||
*/
|
||||
dataGrid_cell?: string;
|
||||
}
|
||||
|
||||
export interface DataGridRowClassNameContract {
|
||||
dataGridRow?: string;
|
||||
dataGridRow__focusedWithin?: string;
|
||||
dataGridRow_cell?: string;
|
||||
}
|
||||
|
||||
export interface DataGridCellClassNameContract {
|
||||
dataGridCell?: string;
|
||||
}
|
|
@ -1,24 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the dialog component
|
||||
*/
|
||||
export interface DialogClassNameContract {
|
||||
/**
|
||||
* The root of the dialog component
|
||||
*/
|
||||
dialog?: string;
|
||||
|
||||
/**
|
||||
* The positioning region for the dialog
|
||||
*/
|
||||
dialog_positioningRegion?: string;
|
||||
|
||||
/**
|
||||
* The element that overlays the page while the modal is visible
|
||||
*/
|
||||
dialog_modalOverlay?: string;
|
||||
|
||||
/**
|
||||
* The dialog content region
|
||||
*/
|
||||
dialog_contentRegion?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the divider component
|
||||
*/
|
||||
export interface DividerClassNameContract {
|
||||
/**
|
||||
* The root of the divider component
|
||||
*/
|
||||
divider?: string;
|
||||
}
|
|
@ -1,29 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the horizontal overflow component
|
||||
*/
|
||||
export interface HorizontalOverflowClassNameContract {
|
||||
/**
|
||||
* The root of the horizontal overflow component
|
||||
*/
|
||||
horizontalOverflow?: string;
|
||||
|
||||
/**
|
||||
* The overflow items container
|
||||
*/
|
||||
horizontalOverflow_contentRegion?: string;
|
||||
|
||||
/**
|
||||
* The overflow item(s)
|
||||
*/
|
||||
horizontalOverflow_item?: string;
|
||||
|
||||
/**
|
||||
* The next scroll control
|
||||
*/
|
||||
horizontalOverflow_next?: string;
|
||||
|
||||
/**
|
||||
* The previous scroll control
|
||||
*/
|
||||
horizontalOverflow_previous?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the hypertext component
|
||||
*/
|
||||
export interface HypertextClassNameContract {
|
||||
/**
|
||||
* The root of the hypertext component
|
||||
*/
|
||||
hypertext?: string;
|
||||
}
|
|
@ -1,19 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the image component
|
||||
*/
|
||||
export interface ImageClassNameContract {
|
||||
/**
|
||||
* The root of the image component
|
||||
*/
|
||||
image?: string;
|
||||
|
||||
/**
|
||||
* The picture element image modifier
|
||||
*/
|
||||
image__picture?: string;
|
||||
|
||||
/**
|
||||
* The img element within the picture element
|
||||
*/
|
||||
image_img?: string;
|
||||
}
|
|
@ -1,33 +0,0 @@
|
|||
export * from "./auto-suggest";
|
||||
export * from "./badge";
|
||||
export * from "./breadcrumb";
|
||||
export * from "./button";
|
||||
export * from "./card";
|
||||
export * from "./checkbox";
|
||||
export * from "./context-menu";
|
||||
export * from "./context-menu-item";
|
||||
export * from "./data-grid";
|
||||
export * from "./dialog";
|
||||
export * from "./divider";
|
||||
export * from "./horizontal-overflow";
|
||||
export * from "./hypertext";
|
||||
export * from "./image";
|
||||
export * from "./label";
|
||||
export * from "./listbox";
|
||||
export * from "./listbox-item";
|
||||
export * from "./number-field";
|
||||
export * from "./managed-classes";
|
||||
export * from "./progress";
|
||||
export * from "./radio";
|
||||
export * from "./select";
|
||||
export * from "./slider";
|
||||
export * from "./slider-track-item";
|
||||
export * from "./stack-panel";
|
||||
export * from "./tabs";
|
||||
export * from "./text-area";
|
||||
export * from "./text-field";
|
||||
export * from "./toggle";
|
||||
export * from "./tree-view";
|
||||
export * from "./tree-view-item";
|
||||
export * from "./typography";
|
||||
export * from "./viewport-positioner";
|
|
@ -1,14 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the label component
|
||||
*/
|
||||
export interface LabelClassNameContract {
|
||||
/**
|
||||
* The root of the label component
|
||||
*/
|
||||
label?: string;
|
||||
|
||||
/**
|
||||
* The hidden from assistive technologies modifier
|
||||
*/
|
||||
label__hidden?: string;
|
||||
}
|
|
@ -1,19 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the listbox-item component
|
||||
*/
|
||||
export interface ListboxItemClassNameContract {
|
||||
/**
|
||||
* The root of the listbox-item component
|
||||
*/
|
||||
listboxItem?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
listboxItem__disabled?: string;
|
||||
|
||||
/**
|
||||
* The selected modifier
|
||||
*/
|
||||
listboxItem__selected?: string;
|
||||
}
|
|
@ -1,14 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the listbox component
|
||||
*/
|
||||
export interface ListboxClassNameContract {
|
||||
/**
|
||||
* The root of the listbox component
|
||||
*/
|
||||
listbox?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
listbox__disabled?: string;
|
||||
}
|
|
@ -1,14 +0,0 @@
|
|||
/**
|
||||
* The interface for class names passed as props
|
||||
*
|
||||
* Allows any string to be used in addition to class names
|
||||
* intended to support the use of Nested at-rules:
|
||||
* https://developer.mozilla.org/en-US/docs/Web/CSS/At-rule
|
||||
*
|
||||
* Note: If TypeScript updated to use RegExp this can be improved
|
||||
* to more strictly check for Nested at-rules:
|
||||
* https://github.com/Microsoft/TypeScript/issues/6579
|
||||
*/
|
||||
export interface ManagedClasses<T> {
|
||||
managedClasses?: { [className in keyof T]?: string };
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the number field component
|
||||
*/
|
||||
export interface NumberFieldClassNameContract {
|
||||
/**
|
||||
* The root of the number field component
|
||||
*/
|
||||
numberField?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the progress component
|
||||
*/
|
||||
export interface ProgressClassNameContract {
|
||||
/**
|
||||
* The root of the progress component
|
||||
*/
|
||||
progress?: string;
|
||||
}
|
|
@ -1,11 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the radio component
|
||||
*/
|
||||
export interface RadioClassNameContract {
|
||||
radio?: string;
|
||||
radio_input?: string;
|
||||
radio_label?: string;
|
||||
radio_stateIndicator?: string;
|
||||
radio__disabled?: string;
|
||||
radio__checked?: string;
|
||||
}
|
|
@ -1,69 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the select component
|
||||
*/
|
||||
export interface SelectClassNameContract {
|
||||
/**
|
||||
* The root of the select component
|
||||
*/
|
||||
select?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
select__disabled?: string;
|
||||
|
||||
/**
|
||||
* If the component is in "scale to fit" mode
|
||||
*/
|
||||
select__scaleToFit?: string;
|
||||
|
||||
/**
|
||||
* The menu of the select component
|
||||
*/
|
||||
select_menu?: string;
|
||||
|
||||
/**
|
||||
* The menu open modifier
|
||||
*/
|
||||
select_menu__open?: string;
|
||||
|
||||
/**
|
||||
* The multi select modifier
|
||||
*/
|
||||
select__multiSelectable?: string;
|
||||
|
||||
/**
|
||||
* select menu positioning wrapper
|
||||
*/
|
||||
select__menuPositioningRegion?: string;
|
||||
|
||||
/**
|
||||
* left positioner horizontal state
|
||||
*/
|
||||
select__menuPositionLeft?: string;
|
||||
|
||||
/**
|
||||
* right positioner horizontal state
|
||||
*/
|
||||
select__menuPositionRight?: string;
|
||||
|
||||
/**
|
||||
* top positioner vertical state
|
||||
*/
|
||||
select__menuPositionTop?: string;
|
||||
|
||||
/**
|
||||
* bottom positioner vertical state
|
||||
*/
|
||||
select__menuPositionBottom?: string;
|
||||
|
||||
/**
|
||||
* horizontal flip inward state
|
||||
*/
|
||||
select__menuPositionHorizontalInset?: string;
|
||||
|
||||
/**
|
||||
* vertical flip inward state
|
||||
*/
|
||||
select__menuPositionVerticalInset?: string;
|
||||
}
|
|
@ -1,19 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the slider track item component
|
||||
*/
|
||||
export interface SliderTrackItemClassNameContract {
|
||||
/**
|
||||
* The root of the slider component
|
||||
*/
|
||||
sliderTrackItem?: string;
|
||||
|
||||
/**
|
||||
* The horizontal orientation modifier
|
||||
*/
|
||||
sliderTrackItem_horizontal?: string;
|
||||
|
||||
/**
|
||||
* The vertical orientation modifier
|
||||
*/
|
||||
sliderTrackItem_vertical?: string;
|
||||
}
|
|
@ -1,98 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the slider component
|
||||
*/
|
||||
export interface SliderClassNameContract {
|
||||
/**
|
||||
* The root of the slider component
|
||||
*/
|
||||
slider?: string;
|
||||
|
||||
/**
|
||||
* The layout region of the slider component. Slider children end up in this container.
|
||||
*/
|
||||
slider_layoutRegion?: string;
|
||||
|
||||
/**
|
||||
* The fixed background track of the slider component
|
||||
* which determines click region and extent of the slider
|
||||
*/
|
||||
slider_track?: string;
|
||||
|
||||
/**
|
||||
* The cosmetic background track of the slider component
|
||||
*/
|
||||
slider_backgroundTrack?: string;
|
||||
|
||||
/**
|
||||
* The cosmetic foreground bar of the slider component that tracks the thumb
|
||||
*/
|
||||
slider_foregroundTrack?: string;
|
||||
|
||||
/**
|
||||
* The horizontal orientation modifier
|
||||
*/
|
||||
slider__horizontal?: string;
|
||||
|
||||
/**
|
||||
* The vertical orientation modifier
|
||||
*/
|
||||
slider__vertical?: string;
|
||||
|
||||
/**
|
||||
* The base thumb class
|
||||
*/
|
||||
slider_thumb?: string;
|
||||
|
||||
/**
|
||||
* The thumb vertical orientation modifier
|
||||
*/
|
||||
slider_thumb__vertical?: string;
|
||||
|
||||
/**
|
||||
* The thumb horizontal orientation modifier
|
||||
*/
|
||||
slider_thumb__horizontal?: string;
|
||||
|
||||
/**
|
||||
* The high value thumb
|
||||
*/
|
||||
slider_thumb__upperValue?: string;
|
||||
|
||||
/**
|
||||
* The low value thumb
|
||||
*/
|
||||
slider_thumb__lowerValue?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
slider__disabled?: string;
|
||||
|
||||
/**
|
||||
* The dragging modifier
|
||||
*/
|
||||
slider__dragging?: string;
|
||||
|
||||
/**
|
||||
* The touch dragging modifier
|
||||
*/
|
||||
slider__touchDragging?: string;
|
||||
|
||||
/**
|
||||
* The incrmenting modifier
|
||||
*/
|
||||
slider__incrementing?: string;
|
||||
|
||||
/**
|
||||
* rtl modifier
|
||||
*/
|
||||
slider__rtl?: string;
|
||||
|
||||
/**
|
||||
* mode modifiers
|
||||
*/
|
||||
slider__modeSingle?: string;
|
||||
slider__modeAdjustLower?: string;
|
||||
slider__modeAdjustUpper?: string;
|
||||
slider__modeAdjustBoth?: string;
|
||||
}
|
|
@ -1,19 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the stackpanel component
|
||||
*/
|
||||
export interface StackPanelClassNameContract {
|
||||
/**
|
||||
* The root of the stackpanel component
|
||||
*/
|
||||
stackPanel?: string;
|
||||
|
||||
/**
|
||||
* the container that contains the stack panel items
|
||||
*/
|
||||
stackPanel_items?: string;
|
||||
|
||||
/**
|
||||
* Applied if the stack panel is scrollable
|
||||
*/
|
||||
stackPanel__scrollable?: string;
|
||||
}
|
|
@ -1,55 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the tabs component
|
||||
*/
|
||||
export interface TabsClassNameContract
|
||||
extends TabClassNameContract,
|
||||
TabPanelClassNameContract {
|
||||
/**
|
||||
* The root of the tabs component
|
||||
*/
|
||||
tabs?: string;
|
||||
|
||||
/**
|
||||
* The tab panels
|
||||
*/
|
||||
tabs_tabPanels?: string;
|
||||
|
||||
/**
|
||||
* The tab list
|
||||
*/
|
||||
tabs_tabList?: string;
|
||||
|
||||
/**
|
||||
* The content that renders in the tab
|
||||
*/
|
||||
tabs_tabContent?: string;
|
||||
|
||||
/**
|
||||
* The content that renders in the tab panel
|
||||
*/
|
||||
tabs_tabPanelContent?: string;
|
||||
}
|
||||
|
||||
export interface TabClassNameContract {
|
||||
/**
|
||||
* The root of the tab components
|
||||
*/
|
||||
tab?: string;
|
||||
|
||||
/**
|
||||
* The active tab modifier
|
||||
*/
|
||||
tab__active?: string;
|
||||
}
|
||||
|
||||
export interface TabPanelClassNameContract {
|
||||
/**
|
||||
* The root of the tab panel component
|
||||
*/
|
||||
tabPanel?: string;
|
||||
|
||||
/**
|
||||
* The hidden tab panel modifier
|
||||
*/
|
||||
tabPanel__hidden?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the text area component
|
||||
*/
|
||||
export interface TextAreaClassNameContract {
|
||||
/**
|
||||
* The root of the text area
|
||||
*/
|
||||
textArea?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the textfield component
|
||||
*/
|
||||
export interface TextFieldClassNameContract {
|
||||
/**
|
||||
* The root of the text field
|
||||
*/
|
||||
textField?: string;
|
||||
}
|
|
@ -1,44 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the toggle component
|
||||
*/
|
||||
export interface ToggleClassNameContract {
|
||||
/**
|
||||
* The root of the toggle component
|
||||
*/
|
||||
toggle?: string;
|
||||
|
||||
/**
|
||||
* The toggle label
|
||||
*/
|
||||
toggle_label?: string;
|
||||
|
||||
/**
|
||||
* The toggle button
|
||||
*/
|
||||
toggle_toggleButton?: string;
|
||||
|
||||
/**
|
||||
* The toggle input element
|
||||
*/
|
||||
toggle_input?: string;
|
||||
|
||||
/**
|
||||
* The toggle state indicator
|
||||
*/
|
||||
toggle_stateIndicator?: string;
|
||||
|
||||
/**
|
||||
* The label indicating state
|
||||
*/
|
||||
toggle_statusMessage?: string;
|
||||
|
||||
/**
|
||||
* Applied when the toggle is disabled
|
||||
*/
|
||||
toggle__disabled?: string;
|
||||
|
||||
/**
|
||||
* Applied when the toggle is checked
|
||||
*/
|
||||
toggle__checked?: string;
|
||||
}
|
|
@ -1,49 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the tree view item component
|
||||
*/
|
||||
export interface TreeViewItemClassNameContract {
|
||||
/**
|
||||
* The root of the tree view item component
|
||||
*/
|
||||
treeViewItem?: string;
|
||||
|
||||
/**
|
||||
* The content region for the tree view item
|
||||
*/
|
||||
treeViewItem_contentRegion?: string;
|
||||
|
||||
/**
|
||||
* The inner content region for the tree view item
|
||||
*/
|
||||
treeViewItem_innerContentRegion?: string;
|
||||
|
||||
/**
|
||||
* The tree view item expand/collapse button
|
||||
*/
|
||||
treeViewItem_expandCollapseButton?: string;
|
||||
|
||||
/**
|
||||
* The tree view item expand/collapse glyph
|
||||
*/
|
||||
treeViewItem_expandCollapseGlyph?: string;
|
||||
|
||||
/**
|
||||
* The tree view item child node region
|
||||
*/
|
||||
treeViewItem_childNodeRegion?: string;
|
||||
|
||||
/**
|
||||
* The expanded modifier for the tree view item
|
||||
*/
|
||||
treeViewItem__expanded?: string;
|
||||
|
||||
/**
|
||||
* The selected modifier for the tree view item
|
||||
*/
|
||||
treeViewItem__selected?: string;
|
||||
|
||||
/**
|
||||
* The nested modifier for the tree view item
|
||||
*/
|
||||
treeViewItem__nested?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the tree view component
|
||||
*/
|
||||
export interface TreeViewClassNameContract {
|
||||
/**
|
||||
* The root of the tree view component
|
||||
*/
|
||||
treeView: string;
|
||||
}
|
|
@ -1,54 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the typography component
|
||||
*/
|
||||
export interface TypographyClassNameContract {
|
||||
/**
|
||||
* The root of the typography component
|
||||
*/
|
||||
typography?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 1 modifier
|
||||
*/
|
||||
typography__1?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 2 modifier
|
||||
*/
|
||||
typography__2?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 3 modifier
|
||||
*/
|
||||
typography__3?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 4 modifier
|
||||
*/
|
||||
typography__4?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 5 modifier
|
||||
*/
|
||||
typography__5?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 6 modifier
|
||||
*/
|
||||
typography__6?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 7 modifier
|
||||
*/
|
||||
typography__7?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 8 modifier
|
||||
*/
|
||||
typography__8?: string;
|
||||
|
||||
/**
|
||||
* The type ramp 9 modifier
|
||||
*/
|
||||
typography__9?: string;
|
||||
}
|
|
@ -1,39 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the viewport positioner component
|
||||
*/
|
||||
export interface ViewportPositionerClassNameContract {
|
||||
/**
|
||||
* The root of the viewport positioner component
|
||||
*/
|
||||
viewportPositioner?: string;
|
||||
|
||||
/**
|
||||
* left positioner horizontal state
|
||||
*/
|
||||
viewportPositioner__left?: string;
|
||||
|
||||
/**
|
||||
* right positioner horizontal state
|
||||
*/
|
||||
viewportPositioner__right?: string;
|
||||
|
||||
/**
|
||||
* top positioner vertical state
|
||||
*/
|
||||
viewportPositioner__top?: string;
|
||||
|
||||
/**
|
||||
* bottom positioner vertical state
|
||||
*/
|
||||
viewportPositioner__bottom?: string;
|
||||
|
||||
/**
|
||||
* horizontal flip inward state
|
||||
*/
|
||||
viewportPositioner__horizontalInset?: string;
|
||||
|
||||
/**
|
||||
* vertical flip inward state
|
||||
*/
|
||||
viewportPositioner__verticalInset?: string;
|
||||
}
|
|
@ -1,9 +0,0 @@
|
|||
{
|
||||
"extends": "./tsconfig.json",
|
||||
"include": [
|
||||
"src/**/*"
|
||||
],
|
||||
"exclude": [
|
||||
"**/*.spec.ts"
|
||||
]
|
||||
}
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"extends": "../../../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"outDir": "./dist"
|
||||
}
|
||||
}
|
|
@ -1,6 +0,0 @@
|
|||
# don't ever lint node_modules
|
||||
node_modules
|
||||
# don't lint build output (make sure it's set to your correct build folder name)
|
||||
dist
|
||||
# don't lint coverage output
|
||||
coverage
|
|
@ -1,3 +0,0 @@
|
|||
module.exports = {
|
||||
extends: ["@microsoft/eslint-config-fast-dna", "prettier"],
|
||||
};
|
|
@ -1,5 +0,0 @@
|
|||
# Source files
|
||||
src/
|
||||
|
||||
# Configs
|
||||
tsconfig.json
|
|
@ -1 +0,0 @@
|
|||
package-lock=false
|
|
@ -1,3 +0,0 @@
|
|||
coverage/*
|
||||
dist/*
|
||||
www/*
|
|
@ -1,591 +0,0 @@
|
|||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
# [4.9.0](https://github.com/microsoft/fast-react/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.9...@microsoft/fast-components-class-name-contracts-msft@4.9.0) (2020-07-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update repo URL to be the soon-to-be archived repo for React packages ([#3498](https://github.com/microsoft/fast-react/issues/3498)) ([693d7fd](https://github.com/microsoft/fast-react/commit/693d7fd70823fbc9cc13d502764dbef8faf27e6f))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update typescript version and remove utility types dependencies for react packages ([#3422](https://github.com/microsoft/fast-react/issues/3422)) ([09d07b5](https://github.com/microsoft/fast-react/commit/09d07b580cda3bcc5d28f83d3568521f710c9576))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.9](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.8...@microsoft/fast-components-class-name-contracts-msft@4.8.9) (2020-06-26)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.8](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.7...@microsoft/fast-components-class-name-contracts-msft@4.8.8) (2020-06-15)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.6](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.5...@microsoft/fast-components-class-name-contracts-msft@4.8.6) (2020-06-05)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.5](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.4...@microsoft/fast-components-class-name-contracts-msft@4.8.5) (2020-05-18)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.4](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.3...@microsoft/fast-components-class-name-contracts-msft@4.8.4) (2020-04-22)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.3](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.2...@microsoft/fast-components-class-name-contracts-msft@4.8.3) (2020-04-10)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.1...@microsoft/fast-components-class-name-contracts-msft@4.8.2) (2020-03-13)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.8.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.8.0...@microsoft/fast-components-class-name-contracts-msft@4.8.1) (2020-02-07)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.8.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.8...@microsoft/fast-components-class-name-contracts-msft@4.8.0) (2019-12-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add tree view as a new component ([#2510](https://github.com/Microsoft/fast/issues/2510)) ([1a1d465](https://github.com/Microsoft/fast/commit/1a1d46566dc6c378a0f1981341a36dcb9897226f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.8](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.7...@microsoft/fast-components-class-name-contracts-msft@4.7.8) (2019-12-11)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.7](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.6...@microsoft/fast-components-class-name-contracts-msft@4.7.7) (2019-11-07)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.6](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.5...@microsoft/fast-components-class-name-contracts-msft@4.7.6) (2019-10-24)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* refactor action toggle ([#2333](https://github.com/Microsoft/fast/issues/2333)) ([2bef0fa](https://github.com/Microsoft/fast/commit/2bef0fab1ed3ef2936952a79e8ba2cc5f67006c2))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.5](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.4...@microsoft/fast-components-class-name-contracts-msft@4.7.5) (2019-10-16)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.4](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.3...@microsoft/fast-components-class-name-contracts-msft@4.7.4) (2019-09-10)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.3](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.2...@microsoft/fast-components-class-name-contracts-msft@4.7.3) (2019-09-05)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* add paused state to progress ([#2197](https://github.com/Microsoft/fast/issues/2197)) ([f08b28e](https://github.com/Microsoft/fast/commit/f08b28e))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.1...@microsoft/fast-components-class-name-contracts-msft@4.7.2) (2019-08-22)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.7.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.7.0...@microsoft/fast-components-class-name-contracts-msft@4.7.1) (2019-08-16)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* enumerate select option glyph in classname contract ([#2135](https://github.com/Microsoft/fast/issues/2135)) ([37c8762](https://github.com/Microsoft/fast/commit/37c8762))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.7.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.6.0...@microsoft/fast-components-class-name-contracts-msft@4.7.0) (2019-07-31)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add support for size 7 heading and subheading ([#2061](https://github.com/Microsoft/fast/issues/2061)) ([ed950fb](https://github.com/Microsoft/fast/commit/ed950fb))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.6.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.5.0...@microsoft/fast-components-class-name-contracts-msft@4.6.0) (2019-07-24)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add circular progress component ([#1998](https://github.com/Microsoft/fast/issues/1998)) ([fda7061](https://github.com/Microsoft/fast/commit/fda7061))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.5.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.4.0...@microsoft/fast-components-class-name-contracts-msft@4.5.0) (2019-07-23)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add flyout as a new component ([#1940](https://github.com/Microsoft/fast/issues/1940)) ([b9ad765](https://github.com/Microsoft/fast/commit/b9ad765))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.4.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.3.2...@microsoft/fast-components-class-name-contracts-msft@4.4.0) (2019-06-25)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add classname to MSFT button for when either before or after content and children exist ([#1877](https://github.com/Microsoft/fast/issues/1877)) ([dae29d6](https://github.com/Microsoft/fast/commit/dae29d6))
|
||||
* add new components for each button appearance style ([#1865](https://github.com/Microsoft/fast/issues/1865)) ([b64d29c](https://github.com/Microsoft/fast/commit/b64d29c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.3.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.3.1...@microsoft/fast-components-class-name-contracts-msft@4.3.2) (2019-06-11)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.3.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.3.0...@microsoft/fast-components-class-name-contracts-msft@4.3.1) (2019-06-05)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* remove margin on glyph when there is no label ([#1757](https://github.com/Microsoft/fast/issues/1757)) ([4179abf](https://github.com/Microsoft/fast/commit/4179abf))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.3.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.2.2...@microsoft/fast-components-class-name-contracts-msft@4.3.0) (2019-05-31)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update the text input components to add 'filled' appearance ([#1782](https://github.com/Microsoft/fast/issues/1782)) ([2249848](https://github.com/Microsoft/fast/commit/2249848))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.2.2](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.2.1...@microsoft/fast-components-class-name-contracts-msft@4.2.2) (2019-05-17)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* base select trigger on input field styles and not button styles ([#1716](https://github.com/Microsoft/fast/issues/1716)) ([07aeb2b](https://github.com/Microsoft/fast/commit/07aeb2b))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.2.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.2.0...@microsoft/fast-components-class-name-contracts-msft@4.2.1) (2019-05-08)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.2.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.1.0...@microsoft/fast-components-class-name-contracts-msft@4.2.0) (2019-04-26)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add slider component ([#1676](https://github.com/Microsoft/fast/issues/1676)) ([6eded38](https://github.com/Microsoft/fast/commit/6eded38))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.1.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.0.1...@microsoft/fast-components-class-name-contracts-msft@4.1.0) (2019-04-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add stealth appearance to button appearance enum ([#1616](https://github.com/Microsoft/fast/issues/1616)) ([771b651](https://github.com/Microsoft/fast/commit/771b651))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [4.0.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@4.0.0...@microsoft/fast-components-class-name-contracts-msft@4.0.1) (2019-04-09)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [4.0.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.9.0...@microsoft/fast-components-class-name-contracts-msft@4.0.0) (2019-03-25)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update to use esModuleInterop in the TypeScript configuration files ([#1211](https://github.com/Microsoft/fast/issues/1211)) ([2ec0644](https://github.com/Microsoft/fast/commit/2ec0644))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* remove appearance prop and add filled prop to control backplate usage ([#1485](https://github.com/Microsoft/fast/issues/1485)) ([87515ac](https://github.com/Microsoft/fast/commit/87515ac))
|
||||
* update action toggle to be styled based off appearance rather than selected state ([#1451](https://github.com/Microsoft/fast/issues/1451)) ([b598457](https://github.com/Microsoft/fast/commit/b598457))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* removes appearance property for badge in favor of filled property
|
||||
* This will affect how imports will be handled by
|
||||
consumers
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.9.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.8.0...@microsoft/fast-components-class-name-contracts-msft@3.9.0) (2019-03-19)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add auto suggest component ([#1551](https://github.com/Microsoft/fast/issues/1551)) ([660fc41](https://github.com/Microsoft/fast/commit/660fc41))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.8.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.7.0...@microsoft/fast-components-class-name-contracts-msft@3.8.0) (2019-03-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add base select component ([#1422](https://github.com/Microsoft/fast/issues/1422)) ([b77a25e](https://github.com/Microsoft/fast/commit/b77a25e))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.7.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.6.0...@microsoft/fast-components-class-name-contracts-msft@3.7.0) (2019-03-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update carousel functionality and design ([#1411](https://github.com/Microsoft/fast/issues/1411)) ([fce4723](https://github.com/Microsoft/fast/commit/fce4723))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.6.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.5.1...@microsoft/fast-components-class-name-contracts-msft@3.6.0) (2019-02-28)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add pivot msft component ([#1385](https://github.com/Microsoft/fast/issues/1385)) ([e81f01c](https://github.com/Microsoft/fast/commit/e81f01c))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## [3.5.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.5.0...@microsoft/fast-components-class-name-contracts-msft@3.5.1) (2019-02-21)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.5.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.4.0...@microsoft/fast-components-class-name-contracts-msft@3.5.0) (2019-02-07)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add badge as an MSFT component ([#1278](https://github.com/Microsoft/fast/issues/1278)) ([79ce26c](https://github.com/Microsoft/fast/commit/79ce26c))
|
||||
* add carousel as a MSFT component ([#1338](https://github.com/Microsoft/fast/issues/1338)) ([b23e2c1](https://github.com/Microsoft/fast/commit/b23e2c1))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.4.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.3.0...@microsoft/fast-components-class-name-contracts-msft@3.4.0) (2019-01-15)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add action toggle component ([#1257](https://github.com/Microsoft/fast/issues/1257)) ([d93508e](https://github.com/Microsoft/fast/commit/d93508e))
|
||||
* add render props for before and after slots in button ([#1266](https://github.com/Microsoft/fast/issues/1266)) ([e4ecc12](https://github.com/Microsoft/fast/commit/e4ecc12))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# [3.3.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.2.1...@microsoft/fast-components-class-name-contracts-msft@3.3.0) (2018-12-31)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add text action as a component ([#1208](https://github.com/Microsoft/fast/issues/1208)) ([d7a7686](https://github.com/Microsoft/fast/commit/d7a7686))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="3.2.1"></a>
|
||||
## [3.2.1](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@3.2.0...@microsoft/fast-components-class-name-contracts-msft@3.2.1) (2018-12-21)
|
||||
|
||||
**Note:** Version bump only for package @microsoft/fast-components-class-name-contracts-msft
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.3.0"></a>
|
||||
# [2.3.0](https://github.com/Microsoft/fast/compare/@microsoft/fast-components-class-name-contracts-msft@2.2.0...@microsoft/fast-components-class-name-contracts-msft@2.3.0) (2018-09-19)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **call-to-action:** add call to action component ([#851](https://github.com/Microsoft/fast/issues/851)) ([05fe0c2](https://github.com/Microsoft/fast/commit/05fe0c2))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.2.0"></a>
|
||||
# 2.2.0 (2018-09-11)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add contrast based color system ([#810](https://github.com/Microsoft/fast/issues/810)) ([5ec457c](https://github.com/Microsoft/fast/commit/5ec457c))
|
||||
* **caption:** add caption component ([#829](https://github.com/Microsoft/fast/issues/829)) ([026cc4e](https://github.com/Microsoft/fast/commit/026cc4e))
|
||||
* **metatext:** add metatext as a new MSFT component ([#818](https://github.com/Microsoft/fast/issues/818)) ([8498687](https://github.com/Microsoft/fast/commit/8498687))
|
||||
* **progress:** add progress component ([#835](https://github.com/Microsoft/fast/issues/835)) ([44d9bb1](https://github.com/Microsoft/fast/commit/44d9bb1))
|
||||
* **subheading:** add subheading component ([#828](https://github.com/Microsoft/fast/issues/828)) ([b988ade](https://github.com/Microsoft/fast/commit/b988ade))
|
||||
|
||||
|
||||
|
||||
<a name="2.1.0"></a>
|
||||
# 2.1.0 (2018-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update Lerna to ^3.0.0 ([#795](https://github.com/Microsoft/fast/issues/795)) ([9ce9a56](https://github.com/Microsoft/fast/commit/9ce9a56))
|
||||
* upgrade to TypeScript 3.0.0 ([#793](https://github.com/Microsoft/fast/issues/793)) ([e203e86](https://github.com/Microsoft/fast/commit/e203e86))
|
||||
* **fast-components-react-base:** add callback to horizontal overflow to return and object that informs scroll start and end ([#797](https://github.com/Microsoft/fast/issues/797)) ([37975f3](https://github.com/Microsoft/fast/commit/37975f3))
|
||||
* **paragraph:** adds paragraph as a new MSFT component ([#805](https://github.com/Microsoft/fast/issues/805)) ([8325d3f](https://github.com/Microsoft/fast/commit/8325d3f))
|
||||
|
||||
|
||||
|
||||
<a name="2.0.0-corrected"></a>
|
||||
# 2.0.0-corrected (2018-08-03)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* travis-CI build-break ([#336](https://github.com/Microsoft/fast/issues/336)) ([bffbf5e](https://github.com/Microsoft/fast/commit/bffbf5e))
|
||||
* **fast-components-react-msft:** fixes error running jest with components that require chroma ([#687](https://github.com/Microsoft/fast/issues/687)) ([140457c](https://github.com/Microsoft/fast/commit/140457c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Forked Class name contracts so we can have one for Base and one for MSFT ([#262](https://github.com/Microsoft/fast/issues/262)) ([a4c54c0](https://github.com/Microsoft/fast/commit/a4c54c0))
|
||||
* update code coverage on travis ([#330](https://github.com/Microsoft/fast/issues/330)) ([63ab4f4](https://github.com/Microsoft/fast/commit/63ab4f4))
|
||||
* **button:** updates to current msft styles ([#314](https://github.com/Microsoft/fast/issues/314)) ([0029e06](https://github.com/Microsoft/fast/commit/0029e06))
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
* **fast-components-react-msft:** add flipper as a new component ([#642](https://github.com/Microsoft/fast/issues/642)) ([5ac4496](https://github.com/Microsoft/fast/commit/5ac4496))
|
||||
* **fast-css-editor-react:** add default editor component and position component ([#636](https://github.com/Microsoft/fast/issues/636)) ([72037a8](https://github.com/Microsoft/fast/commit/72037a8))
|
||||
* **form generator:** updates styles found in configuration pane ([#420](https://github.com/Microsoft/fast/issues/420)) ([919121b](https://github.com/Microsoft/fast/commit/919121b))
|
||||
* **heading:** add heading as a new msft component ([#280](https://github.com/Microsoft/fast/issues/280)) ([b7ee1ab](https://github.com/Microsoft/fast/commit/b7ee1ab))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.1.0"></a>
|
||||
# [2.1.0](https://github.com/Microsoft/fast/compare/v2.0.0-corrected...v2.1.0) (2018-08-29)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* update Lerna to ^3.0.0 ([#795](https://github.com/Microsoft/fast/issues/795)) ([9ce9a56](https://github.com/Microsoft/fast/commit/9ce9a56))
|
||||
* upgrade to TypeScript 3.0.0 ([#793](https://github.com/Microsoft/fast/issues/793)) ([e203e86](https://github.com/Microsoft/fast/commit/e203e86))
|
||||
* **fast-components-react-base:** add callback to horizontal overflow to return and object that informs scroll start and end ([#797](https://github.com/Microsoft/fast/issues/797)) ([37975f3](https://github.com/Microsoft/fast/commit/37975f3))
|
||||
* **paragraph:** adds paragraph as a new MSFT component ([#805](https://github.com/Microsoft/fast/issues/805)) ([8325d3f](https://github.com/Microsoft/fast/commit/8325d3f))
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="2.0.0"></a>
|
||||
# [2.0.0](https://github.com/Microsoft/fast/compare/v1.6.0...v2.0.0) (2018-08-02)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **fast-components-react-msft:** fixes error running jest with components that require chroma ([#687](https://github.com/Microsoft/fast/issues/687)) ([140457c](https://github.com/Microsoft/fast/commit/140457c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
* **fast-components-react-msft:** add flipper as a new component ([#642](https://github.com/Microsoft/fast/issues/642)) ([5ac4496](https://github.com/Microsoft/fast/commit/5ac4496))
|
||||
* **fast-css-editor-react:** add default editor component and position component ([#636](https://github.com/Microsoft/fast/issues/636)) ([72037a8](https://github.com/Microsoft/fast/commit/72037a8))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.9.0"></a>
|
||||
# [1.9.0](https://github.com/Microsoft/fast/compare/v1.6.0...v1.9.0) (2018-07-14)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **fast-components-react-msft:** fixes error running jest with components that require chroma ([#687](https://github.com/Microsoft/fast/issues/687)) ([140457c](https://github.com/Microsoft/fast/commit/140457c))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
* **fast-components-react-msft:** add flipper as a new component ([#642](https://github.com/Microsoft/fast/issues/642)) ([5ac4496](https://github.com/Microsoft/fast/commit/5ac4496))
|
||||
* **fast-css-editor-react:** add default editor component and position component ([#636](https://github.com/Microsoft/fast/issues/636)) ([72037a8](https://github.com/Microsoft/fast/commit/72037a8))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.8.0"></a>
|
||||
# [1.8.0](https://github.com/Microsoft/fast/compare/v1.6.0...v1.8.0) (2018-06-12)
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.7.0"></a>
|
||||
# [1.7.0](https://github.com/Microsoft/fast/compare/v1.6.0...v1.7.0) (2018-06-01)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **detail view:** add detail view ([#470](https://github.com/Microsoft/fast/issues/470)) ([665b871](https://github.com/Microsoft/fast/commit/665b871))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.6.0"></a>
|
||||
# [1.6.0](https://github.com/Microsoft/fast/compare/v1.2.0...v1.6.0) (2018-05-16)
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.5.0"></a>
|
||||
# [1.5.0](https://github.com/Microsoft/fast/compare/v1.2.0...v1.5.0) (2018-05-16)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **form generator:** updates styles found in configuration pane ([#420](https://github.com/Microsoft/fast/issues/420)) ([919121b](https://github.com/Microsoft/fast/commit/919121b))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.4.0"></a>
|
||||
# [1.4.0](https://github.com/Microsoft/fast/compare/v1.2.0...v1.4.0) (2018-05-14)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **form generator:** updates styles found in configuration pane ([#420](https://github.com/Microsoft/fast/issues/420)) ([919121b](https://github.com/Microsoft/fast/commit/919121b))
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="1.2.0"></a>
|
||||
# 1.2.0 (2018-05-10)
|
||||
|
||||
<a name="1.1.0"></a>
|
||||
# 1.1.0 (2018-05-09)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* travis-CI build-break ([#336](https://github.com/Microsoft/fast/issues/336)) ([bffbf5e](https://github.com/Microsoft/fast/commit/bffbf5e))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* Forked Class name contracts so we can have one for Base and one for MSFT ([#262](https://github.com/Microsoft/fast/issues/262)) ([a4c54c0](https://github.com/Microsoft/fast/commit/a4c54c0))
|
||||
* update code coverage on travis ([#330](https://github.com/Microsoft/fast/issues/330)) ([63ab4f4](https://github.com/Microsoft/fast/commit/63ab4f4))
|
||||
* **button:** updates to current msft styles ([#314](https://github.com/Microsoft/fast/issues/314)) ([0029e06](https://github.com/Microsoft/fast/commit/0029e06))
|
||||
* **heading:** add heading as a new msft component ([#280](https://github.com/Microsoft/fast/issues/280)) ([b7ee1ab](https://github.com/Microsoft/fast/commit/b7ee1ab))
|
|
@ -1,3 +0,0 @@
|
|||
# FAST Components class name contracts MSFT
|
||||
|
||||
This package refrences the BASE class name contracts and provides the TypeScript typings for all MSFT components class name contracts. These contracts enable strict typing of JSS stylesheets and each component's expectation of which class names will be made available (and under which keys those class names reside) to the component at runtime.
|
|
@ -1,40 +0,0 @@
|
|||
{
|
||||
"name": "@microsoft/fast-components-class-name-contracts-msft",
|
||||
"description": "Type descriptions for the classnames that any given component can expect as props.",
|
||||
"sideEffects": false,
|
||||
"version": "4.9.0",
|
||||
"author": {
|
||||
"name": "Microsoft",
|
||||
"url": "https://discord.gg/FcSNfg4"
|
||||
},
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/microsoft/fast-react.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/Microsoft/fast/issues/new/choose"
|
||||
},
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"scripts": {
|
||||
"build": "tsc -p ./tsconfig.build.json",
|
||||
"clean:dist": "node ../../../build/clean.js dist",
|
||||
"prepare": "yarn clean:dist && yarn build",
|
||||
"prettier": "prettier --config ../../../.prettierrc --write \"**/*.ts\"",
|
||||
"prettier:diff": "prettier --config ../../../.prettierrc \"**/*.ts\" --list-different",
|
||||
"test": "yarn eslint",
|
||||
"eslint": "eslint . --ext .ts",
|
||||
"eslint:fix": "eslint . --ext .ts --fix",
|
||||
"watch": "yarn build -- -w --preserveWatchOutput"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@microsoft/eslint-config-fast-dna": "^1.2.0",
|
||||
"eslint-config-prettier": "^6.10.1",
|
||||
"prettier": "2.0.2",
|
||||
"typescript": "^3.9.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"@microsoft/fast-components-class-name-contracts-base": "^4.8.0"
|
||||
}
|
||||
}
|
|
@ -1,64 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the action toggle component
|
||||
*/
|
||||
export interface ActionToggleClassNameContract {
|
||||
/**
|
||||
* The root of the action toggle component
|
||||
*/
|
||||
actionToggle?: string;
|
||||
|
||||
/**
|
||||
* The selected modifier
|
||||
*/
|
||||
actionToggle__selected?: string;
|
||||
|
||||
/**
|
||||
* Applied to both selected and unselected glyphs
|
||||
*/
|
||||
actionToggle_glyph?: string;
|
||||
|
||||
/**
|
||||
* The action toggle selected glyph
|
||||
*/
|
||||
actionToggle_selectedGlyph?: string;
|
||||
|
||||
/**
|
||||
* The action toggle unselected glyph
|
||||
*/
|
||||
actionToggle_unselectedGlyph?: string;
|
||||
|
||||
/**
|
||||
* The justified appearance modifier
|
||||
*/
|
||||
actionToggle__justified?: string;
|
||||
|
||||
/**
|
||||
* The lightweight appearance modifier
|
||||
*/
|
||||
actionToggle__lightweight?: string;
|
||||
|
||||
/**
|
||||
* The outline appearance modifier
|
||||
*/
|
||||
actionToggle__outline?: string;
|
||||
|
||||
/**
|
||||
* The primary appearance modifier
|
||||
*/
|
||||
actionToggle__primary?: string;
|
||||
|
||||
/**
|
||||
* The stealth appearance modifier
|
||||
*/
|
||||
actionToggle__stealth?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
actionToggle__disabled?: string;
|
||||
|
||||
/**
|
||||
* The single element modifier
|
||||
*/
|
||||
actionToggle__hasGlyphAndContent?: string;
|
||||
}
|
|
@ -1,48 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the action trigger component
|
||||
*/
|
||||
export interface ActionTriggerClassNameContract {
|
||||
/**
|
||||
* The root of the action trigger component
|
||||
*/
|
||||
actionTrigger?: string;
|
||||
/**
|
||||
* The action trigger glyph
|
||||
*/
|
||||
actionTrigger_glyph?: string;
|
||||
|
||||
/**
|
||||
* The justified appearance modifier
|
||||
*/
|
||||
actionTrigger__justified?: string;
|
||||
|
||||
/**
|
||||
* The lightweight appearance modifier
|
||||
*/
|
||||
actionTrigger__lightweight?: string;
|
||||
|
||||
/**
|
||||
* The outline appearance modifier
|
||||
*/
|
||||
actionTrigger__outline?: string;
|
||||
|
||||
/**
|
||||
* The primary appearance modifier
|
||||
*/
|
||||
actionTrigger__primary?: string;
|
||||
|
||||
/**
|
||||
* The stealth appearance modifier
|
||||
*/
|
||||
actionTrigger__stealth?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
actionTrigger__disabled?: string;
|
||||
|
||||
/**
|
||||
* Action trigger class name used when checking glyph and content
|
||||
*/
|
||||
actionTrigger__hasGlyphAndContent?: string;
|
||||
}
|
|
@ -1,27 +0,0 @@
|
|||
import { ListboxItemClassNameContract as BaseListboxItemClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the auto suggest option component
|
||||
*/
|
||||
export interface AutoSuggestOptionClassNameContract
|
||||
extends BaseListboxItemClassNameContract {
|
||||
/**
|
||||
* The root of the auto suggest option component
|
||||
*/
|
||||
autoSuggestOption?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
autoSuggestOption__disabled?: string;
|
||||
|
||||
/**
|
||||
* The selected modifier
|
||||
*/
|
||||
autoSuggestOption__selected?: string;
|
||||
|
||||
/**
|
||||
* The auto suggest option content region
|
||||
*/
|
||||
autoSuggestOption_contentRegion?: string;
|
||||
}
|
|
@ -1,11 +0,0 @@
|
|||
import { AutoSuggestClassNameContract as BaseAutoSuggestClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the select component
|
||||
*/
|
||||
export interface AutoSuggestClassNameContract extends BaseAutoSuggestClassNameContract {
|
||||
/**
|
||||
* The glyph shown in the select toggle button
|
||||
*/
|
||||
select_toggleGlyph?: string;
|
||||
}
|
|
@ -1,21 +0,0 @@
|
|||
import { BadgeClassNameContract as BaseBadgeClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the badge component
|
||||
*/
|
||||
export interface BadgeClassNameContract extends BaseBadgeClassNameContract {
|
||||
/**
|
||||
* The small size
|
||||
*/
|
||||
badge__small?: string;
|
||||
|
||||
/**
|
||||
* The large size
|
||||
*/
|
||||
badge__large?: string;
|
||||
|
||||
/**
|
||||
* The filled backplate appearance style
|
||||
*/
|
||||
badge__filled: string;
|
||||
}
|
|
@ -1,26 +0,0 @@
|
|||
import { ButtonClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the button component
|
||||
*/
|
||||
export interface ButtonBaseClassNameContract extends ButtonClassNameContract {
|
||||
/**
|
||||
* The button content region
|
||||
*/
|
||||
button_contentRegion?: string;
|
||||
|
||||
/**
|
||||
* The before content
|
||||
*/
|
||||
button_beforeContent?: string;
|
||||
|
||||
/**
|
||||
* The after content
|
||||
*/
|
||||
button_afterContent?: string;
|
||||
|
||||
/**
|
||||
* Class name used when button has either beforeContent or afterContent and children
|
||||
*/
|
||||
button__hasBeforeOrAfterAndChildren?: string;
|
||||
}
|
|
@ -1,46 +0,0 @@
|
|||
import { ButtonClassNameContract as BaseButtonClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the button component
|
||||
*/
|
||||
export interface ButtonClassNameContract extends BaseButtonClassNameContract {
|
||||
/**
|
||||
* The primary appearance modifier
|
||||
*/
|
||||
button__primary?: string;
|
||||
|
||||
/**
|
||||
* The outline appearance modifier
|
||||
*/
|
||||
button__outline?: string;
|
||||
|
||||
/**
|
||||
* The lightweight appearance modifier
|
||||
*/
|
||||
button__lightweight?: string;
|
||||
|
||||
/**
|
||||
* The justified appearance modifier
|
||||
*/
|
||||
button__justified?: string;
|
||||
|
||||
/**
|
||||
* The stealth appearance modifier
|
||||
*/
|
||||
button__stealth?: string;
|
||||
|
||||
/**
|
||||
* The button content region
|
||||
*/
|
||||
button_contentRegion?: string;
|
||||
|
||||
/**
|
||||
* The before content
|
||||
*/
|
||||
button_beforeContent?: string;
|
||||
|
||||
/**
|
||||
* The after content
|
||||
*/
|
||||
button_afterContent?: string;
|
||||
}
|
|
@ -1,44 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the call to action component
|
||||
*/
|
||||
export interface CallToActionClassNameContract {
|
||||
/**
|
||||
* The root of the call to action component
|
||||
*/
|
||||
callToAction?: string;
|
||||
|
||||
/**
|
||||
* The call to action glyph
|
||||
*/
|
||||
callToAction_glyph?: string;
|
||||
|
||||
/**
|
||||
* The justified appearance modifier
|
||||
*/
|
||||
callToAction__justified?: string;
|
||||
|
||||
/**
|
||||
* The lightweight appearance modifier
|
||||
*/
|
||||
callToAction__lightweight?: string;
|
||||
|
||||
/**
|
||||
* The outline appearance modifier
|
||||
*/
|
||||
callToAction__outline?: string;
|
||||
|
||||
/**
|
||||
* The primary appearance modifier
|
||||
*/
|
||||
callToAction__primary?: string;
|
||||
|
||||
/**
|
||||
* The stealth appearance modifier
|
||||
*/
|
||||
callToAction__stealth?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
callToAction__disabled?: string;
|
||||
}
|
|
@ -1,19 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the caption component
|
||||
*/
|
||||
export interface CaptionClassNameContract {
|
||||
/**
|
||||
* The root of the caption component
|
||||
*/
|
||||
caption?: string;
|
||||
|
||||
/**
|
||||
* The size 1 modifier
|
||||
*/
|
||||
caption__1?: string;
|
||||
|
||||
/**
|
||||
* The size 2 modifier
|
||||
*/
|
||||
caption__2?: string;
|
||||
}
|
|
@ -1,80 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the carousel component
|
||||
*/
|
||||
|
||||
export interface CarouselClassNameContract {
|
||||
/**
|
||||
* The root of the carousel component
|
||||
*/
|
||||
carousel?: string;
|
||||
|
||||
/**
|
||||
* The collection of tabs and tab panels
|
||||
*/
|
||||
carousel_slides?: string;
|
||||
|
||||
/**
|
||||
* The collection of sequence indicators
|
||||
*/
|
||||
carousel_sequenceIndicators?: string;
|
||||
|
||||
/**
|
||||
* The sequence indicator
|
||||
*/
|
||||
carousel_sequenceIndicator?: string;
|
||||
|
||||
/**
|
||||
* The active carousel sequence indicator
|
||||
*/
|
||||
carousel_sequenceIndicator__active?: string;
|
||||
|
||||
/**
|
||||
* The collection of tab panels
|
||||
*/
|
||||
carousel_tabPanels?: string;
|
||||
|
||||
/**
|
||||
* The tab panel
|
||||
*/
|
||||
carousel_tabPanel?: string;
|
||||
|
||||
/**
|
||||
* The hidden tab panel
|
||||
*/
|
||||
carousel_tabPanel__hidden?: string;
|
||||
|
||||
/**
|
||||
* The tab panel content
|
||||
*/
|
||||
carousel_tabPanelContent?: string;
|
||||
|
||||
/**
|
||||
* The carousel's previous flipper
|
||||
*/
|
||||
carousel_flipperPrevious?: string;
|
||||
|
||||
/**
|
||||
* The carousel's next flipper
|
||||
*/
|
||||
carousel_flipperNext?: string;
|
||||
|
||||
/**
|
||||
* The light slide theme
|
||||
*/
|
||||
carousel__themeLight?: string;
|
||||
|
||||
/**
|
||||
* The dark slide theme
|
||||
*/
|
||||
carousel__themeDark?: string;
|
||||
|
||||
/**
|
||||
* The previous slide transition
|
||||
*/
|
||||
carousel__slideAnimatePrevious?: string;
|
||||
|
||||
/**
|
||||
* The next slide transition
|
||||
*/
|
||||
carousel__slideAnimateNext?: string;
|
||||
}
|
|
@ -1,12 +0,0 @@
|
|||
import { ContextMenuItemClassNameContract as BaseContextMenuItemClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the context menu item component
|
||||
*/
|
||||
export interface ContextMenuItemClassNameContract
|
||||
extends BaseContextMenuItemClassNameContract {
|
||||
/**
|
||||
* The context menu item content region
|
||||
*/
|
||||
contextMenuItem_contentRegion?: string;
|
||||
}
|
|
@ -1,7 +0,0 @@
|
|||
import { DataGridClassNameContract as BaseDataGridClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the data grid component
|
||||
*/
|
||||
/* eslint-disable-next-line @typescript-eslint/no-empty-interface */
|
||||
export interface DataGridClassNameContract extends BaseDataGridClassNameContract {}
|
|
@ -1,24 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the flipper component
|
||||
*/
|
||||
export interface FlipperClassNameContract {
|
||||
/**
|
||||
* The root of the flipper component
|
||||
*/
|
||||
flipper?: string;
|
||||
|
||||
/**
|
||||
* The flipper glyph
|
||||
*/
|
||||
flipper_glyph?: string;
|
||||
|
||||
/**
|
||||
* The next direction flipper modifier
|
||||
*/
|
||||
flipper__next?: string;
|
||||
|
||||
/**
|
||||
* The previous direction flipper modifier
|
||||
*/
|
||||
flipper__previous?: string;
|
||||
}
|
|
@ -1,39 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the flyout component
|
||||
*/
|
||||
export interface FlyoutClassNameContract {
|
||||
/**
|
||||
* The root of the flyout component
|
||||
*/
|
||||
flyout?: string;
|
||||
|
||||
/**
|
||||
* left flyout horizontal state
|
||||
*/
|
||||
flyout__left?: string;
|
||||
|
||||
/**
|
||||
* right flyout horizontal state
|
||||
*/
|
||||
flyout__right?: string;
|
||||
|
||||
/**
|
||||
* top flyout vertical state
|
||||
*/
|
||||
flyout__top?: string;
|
||||
|
||||
/**
|
||||
* bottom flyout vertical state
|
||||
*/
|
||||
flyout__bottom?: string;
|
||||
|
||||
/**
|
||||
* horizontal flip inward state
|
||||
*/
|
||||
flyout__horizontalInset?: string;
|
||||
|
||||
/**
|
||||
* vertical flip inward state
|
||||
*/
|
||||
flyout__verticalInset?: string;
|
||||
}
|
|
@ -1,44 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the heading component
|
||||
*/
|
||||
export interface HeadingClassNameContract {
|
||||
/**
|
||||
* The root of the heading component
|
||||
*/
|
||||
heading?: string;
|
||||
|
||||
/**
|
||||
* The size 1 modifier
|
||||
*/
|
||||
heading__1?: string;
|
||||
|
||||
/**
|
||||
* The size 2 modifier
|
||||
*/
|
||||
heading__2?: string;
|
||||
|
||||
/**
|
||||
* The size 3 modifier
|
||||
*/
|
||||
heading__3?: string;
|
||||
|
||||
/**
|
||||
* The size 4 modifier
|
||||
*/
|
||||
heading__4?: string;
|
||||
|
||||
/**
|
||||
* The size 5 modifier
|
||||
*/
|
||||
heading__5?: string;
|
||||
|
||||
/**
|
||||
* The size 6 modifier
|
||||
*/
|
||||
heading__6?: string;
|
||||
|
||||
/**
|
||||
* The size 7 modifier
|
||||
*/
|
||||
heading__7?: string;
|
||||
}
|
|
@ -1,28 +0,0 @@
|
|||
export * from "./action-toggle";
|
||||
export * from "./action-trigger";
|
||||
export * from "./auto-suggest";
|
||||
export * from "./auto-suggest-option";
|
||||
export * from "./badge";
|
||||
export * from "./button";
|
||||
export * from "./button-base";
|
||||
export * from "./call-to-action";
|
||||
export * from "./caption";
|
||||
export * from "./carousel";
|
||||
export * from "./context-menu-item";
|
||||
export * from "./data-grid";
|
||||
export * from "./flipper";
|
||||
export * from "./flyout";
|
||||
export * from "./heading";
|
||||
export * from "./managed-classes";
|
||||
export * from "./metatext";
|
||||
export * from "./paragraph";
|
||||
export * from "./pivot";
|
||||
export * from "./progress";
|
||||
export * from "./select";
|
||||
export * from "./select-option";
|
||||
export * from "./slider";
|
||||
export * from "./slider-label";
|
||||
export * from "./subheading";
|
||||
export * from "./text-action";
|
||||
export * from "./text-field";
|
||||
export * from "./tree-view-item";
|
|
@ -1 +0,0 @@
|
|||
export { ManagedClasses } from "@microsoft/fast-components-class-name-contracts-base";
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the metatext component
|
||||
*/
|
||||
export interface MetatextClassNameContract {
|
||||
/**
|
||||
* The root of the metatext component
|
||||
*/
|
||||
metatext?: string;
|
||||
}
|
|
@ -1,24 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the paragraph component
|
||||
*/
|
||||
export interface ParagraphClassNameContract {
|
||||
/**
|
||||
* The root of the paragraph component
|
||||
*/
|
||||
paragraph?: string;
|
||||
|
||||
/**
|
||||
* The size 1 modifier
|
||||
*/
|
||||
paragraph__1?: string;
|
||||
|
||||
/**
|
||||
* The size 2 modifier
|
||||
*/
|
||||
paragraph__2?: string;
|
||||
|
||||
/**
|
||||
* The size 3 modifier
|
||||
*/
|
||||
paragraph__3?: string;
|
||||
}
|
|
@ -1,64 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the pivot component
|
||||
*/
|
||||
export interface PivotClassNameContract {
|
||||
/**
|
||||
* The root of the pivot component
|
||||
*/
|
||||
pivot?: string;
|
||||
|
||||
/**
|
||||
* The active pivot indicator
|
||||
*/
|
||||
pivot_activeIndicator?: string;
|
||||
|
||||
/**
|
||||
* The collection of pivot items
|
||||
*/
|
||||
pivot_tabList?: string;
|
||||
|
||||
/**
|
||||
* The pivot item
|
||||
*/
|
||||
pivot_tab?: string;
|
||||
|
||||
/**
|
||||
* The active pivot item
|
||||
*/
|
||||
pivot_tab__active?: string;
|
||||
|
||||
/**
|
||||
* The pivot tab content
|
||||
*/
|
||||
pivot_tabContent?: string;
|
||||
|
||||
/**
|
||||
* The collection of tab panels
|
||||
*/
|
||||
pivot_tabPanels?: string;
|
||||
|
||||
/**
|
||||
* The previous panel animation
|
||||
*/
|
||||
pivot_tabPanels__animatePrevious?: string;
|
||||
|
||||
/**
|
||||
* The next tab panel animation
|
||||
*/
|
||||
pivot_tabPanels__animateNext?: string;
|
||||
|
||||
/**
|
||||
* The tab panel
|
||||
*/
|
||||
pivot_tabPanel?: string;
|
||||
|
||||
/**
|
||||
* The hidden tab panel
|
||||
*/
|
||||
pivot_tabPanel__hidden?: string;
|
||||
|
||||
/**
|
||||
* The tab panel content
|
||||
*/
|
||||
pivot_tabPanelContent?: string;
|
||||
}
|
|
@ -1,81 +0,0 @@
|
|||
import { ProgressClassNameContract as BaseProgressClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the progress component
|
||||
*/
|
||||
export interface ProgressClassNameContract extends BaseProgressClassNameContract {
|
||||
/**
|
||||
* The root progress circular modifier
|
||||
*/
|
||||
progress__circular?: string;
|
||||
|
||||
/**
|
||||
* The root progress paused modifier
|
||||
*/
|
||||
progress__paused?: string;
|
||||
|
||||
/**
|
||||
* The progress size control modifier
|
||||
*/
|
||||
progress_circularSVG__control: string;
|
||||
|
||||
/**
|
||||
* The progress size container modifier
|
||||
*/
|
||||
progress_circularSVG__container: string;
|
||||
|
||||
/**
|
||||
* The progress size page modifier
|
||||
*/
|
||||
progress_circularSVG__page: string;
|
||||
|
||||
/**
|
||||
* The progress value indicator
|
||||
*/
|
||||
progress_valueIndicator?: string;
|
||||
|
||||
/**
|
||||
* The indeterminate progress value indicator
|
||||
*/
|
||||
progress_valueIndicator__indeterminate?: string;
|
||||
|
||||
/**
|
||||
* The indeterminate progress indicator
|
||||
*/
|
||||
progress_indicator?: string;
|
||||
|
||||
/**
|
||||
* The determinate progress value indicator
|
||||
*/
|
||||
progress_indicator__determinate?: string;
|
||||
|
||||
/**
|
||||
* The indeterminate progress indicator
|
||||
*/
|
||||
progress_dot?: string;
|
||||
|
||||
/**
|
||||
* The indeterminate progress indicator 1 modifier
|
||||
*/
|
||||
progress_dot__1?: string;
|
||||
|
||||
/**
|
||||
* The indeterminate progress indicator 2 modifier
|
||||
*/
|
||||
progress_dot__2?: string;
|
||||
|
||||
/**
|
||||
* @Deprecated 3.4.0
|
||||
*/
|
||||
progress_dot__3?: string;
|
||||
|
||||
/**
|
||||
* @Deprecated 3.4.0
|
||||
*/
|
||||
progress_dot__4?: string;
|
||||
|
||||
/**
|
||||
* @Deprecated 3.4.0
|
||||
*/
|
||||
progress_dot__5?: string;
|
||||
}
|
|
@ -1,31 +0,0 @@
|
|||
import { ListboxItemClassNameContract as BaseListboxItemClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the select option component
|
||||
*/
|
||||
export interface SelectOptionClassNameContract extends BaseListboxItemClassNameContract {
|
||||
/**
|
||||
* The root of the select option component
|
||||
*/
|
||||
selectOption?: string;
|
||||
|
||||
/**
|
||||
* The disabled modifier
|
||||
*/
|
||||
selectOption__disabled?: string;
|
||||
|
||||
/**
|
||||
* The selected modifier
|
||||
*/
|
||||
selectOption__selected?: string;
|
||||
|
||||
/**
|
||||
* Select option content region
|
||||
*/
|
||||
selectOption_contentRegion?: string;
|
||||
|
||||
/**
|
||||
* Select option glyph
|
||||
*/
|
||||
selectOption_glyph?: string;
|
||||
}
|
|
@ -1,26 +0,0 @@
|
|||
import { SelectClassNameContract as BaseSelectClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the select component
|
||||
*/
|
||||
export interface SelectClassNameContract extends BaseSelectClassNameContract {
|
||||
/**
|
||||
* The glyph shown in the select toggle button
|
||||
*/
|
||||
select_toggleGlyph?: string;
|
||||
|
||||
/**
|
||||
* The select toggle button
|
||||
*/
|
||||
select_button?: string;
|
||||
|
||||
/**
|
||||
* The select toggle button content region
|
||||
*/
|
||||
select_buttonContentRegion?: string;
|
||||
|
||||
/**
|
||||
* The display text container
|
||||
*/
|
||||
select_buttonDisplayText?: string;
|
||||
}
|
|
@ -1,54 +0,0 @@
|
|||
import { SliderTrackItemClassNameContract as BaseSliderTrackItemClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the slider label component
|
||||
*/
|
||||
export interface SliderLabelClassNameContract
|
||||
extends BaseSliderTrackItemClassNameContract {
|
||||
/**
|
||||
* The root of the slider label component
|
||||
*/
|
||||
sliderLabel?: string;
|
||||
|
||||
/**
|
||||
* The label portion of the slider label component
|
||||
*/
|
||||
sliderLabel_positioningRegion?: string;
|
||||
|
||||
/**
|
||||
* The label portion of the slider label component
|
||||
*/
|
||||
sliderLabel_label?: string;
|
||||
|
||||
/**
|
||||
* The label position min modifier,
|
||||
* applied to positioning panel at min end of range
|
||||
*/
|
||||
sliderLabel__positionMin?: string;
|
||||
|
||||
/**
|
||||
* The label position max modifier
|
||||
* applied to positioning panel at max end of range
|
||||
*/
|
||||
sliderLabel__positionMax?: string;
|
||||
|
||||
/**
|
||||
* The tick mark portion of the slider label component
|
||||
*/
|
||||
sliderLabel_tickMark?: string;
|
||||
|
||||
/**
|
||||
* The horizontal orientation modifier
|
||||
*/
|
||||
sliderLabel__horizontal?: string;
|
||||
|
||||
/**
|
||||
* The vertical orientation modifier
|
||||
*/
|
||||
sliderLabel__vertical?: string;
|
||||
|
||||
/**
|
||||
* The rtl modifier
|
||||
*/
|
||||
sliderLabel__rtl?: string;
|
||||
}
|
|
@ -1,7 +0,0 @@
|
|||
import { SliderClassNameContract as BaseSliderClassNameContract } from "@microsoft/fast-components-class-name-contracts-base";
|
||||
|
||||
/**
|
||||
* The class name contract for the select component
|
||||
*/
|
||||
/* eslint-disable-next-line @typescript-eslint/no-empty-interface */
|
||||
export interface SliderClassNameContract extends BaseSliderClassNameContract {}
|
|
@ -1,44 +0,0 @@
|
|||
/**
|
||||
* The class name contract for the subheading component
|
||||
*/
|
||||
export interface SubheadingClassNameContract {
|
||||
/**
|
||||
* The root of the subheading component
|
||||
*/
|
||||
subheading?: string;
|
||||
|
||||
/**
|
||||
* The size 1 modifier
|
||||
*/
|
||||
subheading__1?: string;
|
||||
|
||||
/**
|
||||
* The size 2 modifier
|
||||
*/
|
||||
subheading__2?: string;
|
||||
|
||||
/**
|
||||
* The size 3 modifier
|
||||
*/
|
||||
subheading__3?: string;
|
||||
|
||||
/**
|
||||
* The size 4 modifier
|
||||
*/
|
||||
subheading__4?: string;
|
||||
|
||||
/**
|
||||
* The size 5 modifier
|
||||
*/
|
||||
subheading__5?: string;
|
||||
|
||||
/**
|
||||
* The size 6 modifier
|
||||
*/
|
||||
subheading__6?: string;
|
||||
|
||||
/**
|
||||
* The size 7 modifier
|
||||
*/
|
||||
subheading__7?: string;
|
||||
}
|
Некоторые файлы не были показаны из-за слишком большого количества измененных файлов Показать больше
Загрузка…
Ссылка в новой задаче