sp-dev-fx-webparts/samples/knockout-taxonomy/README.md

96 lines
4.6 KiB
Markdown
Raw Normal View History

---
page_type: sample
products:
- office-sp
languages:
- javascript
- typescript
extensions:
contentType: samples
technologies:
- SharePoint Framework
platforms:
- knockout
createdDate: 1/1/2016 12:00:00 AM
---
2020-11-08 23:11:25 -05:00
# Taxonomy
2016-11-08 19:26:52 -05:00
2016-11-12 18:26:50 -05:00
## Summary
Sample Web Part illustrating
* Reading taxonomy term stores' hierarchy from SharePoint
* Loading JavaScript Object Model scripts
* creating Knockout components
2016-11-08 19:26:52 -05:00
2016-11-12 18:26:50 -05:00
![Taxonomy Sample Web Part](./assets/Taxonomy.png)
2016-11-08 19:26:52 -05:00
2021-11-07 01:33:53 -05:00
## Compatibility
![SPFx 1.0.0](https://img.shields.io/badge/SPFx-1.0.0-green.svg)
![Node.js v6](https://img.shields.io/badge/Node.js-v6-green.svg)
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Compatible SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Compatible-green.svg)
![Compatible with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Compatible-green.svg)
![Local Workbench Compatible](https://img.shields.io/badge/Local%20Workbench-Compatible-green.svg)
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2022-02-16 21:47:07 -05:00
![Compatible with Remote Containers](https://img.shields.io/badge/Remote%20Containers-Compatible-green.svg)
2021-11-07 01:33:53 -05:00
2016-11-12 18:26:50 -05:00
## Applies to
2016-11-08 19:26:52 -05:00
* [SharePoint Framework Developer Preview](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
2016-11-08 19:26:52 -05:00
2016-11-12 18:26:50 -05:00
## Solution
2016-11-08 19:26:52 -05:00
2016-11-12 18:26:50 -05:00
Solution|Author(s)
--------|---------
2021-11-21 02:51:08 -05:00
knockout-taxonomy | [Alex Terentiev](https://github.com/AJIXuMuK) ([Sharepointalist Inc.](http://www.sharepointalist.com), [AJIXuMuK](https://github.com/AJIXuMuK))
2016-11-08 19:26:52 -05:00
2016-11-12 18:26:50 -05:00
## Version history
Version|Date|Comments
-------|----|--------
1.0|November 12, 2016|Initial release
1.1|May 5, 2017|Update to GA Release, fix of minor bug
2016-11-12 18:26:50 -05:00
## Minimal Path to Awesome
- Clone this repository
- in the command line run:
- `npm i`
- `gulp serve`
2022-02-16 21:47:07 -05:00
> This sample can also be opened with [VS Code Remote Development](https://code.visualstudio.com/docs/remote/remote-overview). Visit https://aka.ms/spfx-devcontainer for further instructions.
2016-11-12 18:26:50 -05:00
## Features
This project contains Client-Side Web Part built on the SharePoint Framework illustrating how to request Taxonomy Term Stores' hierarchy from SharePoint.
This Web Part illustrates the following concepts on top of the SharePoint Framework:
- Reading taxonomy term stores' hierarchy from SharePoint
- Loading JavaScript Object Model scripts (init.js, sp.runtime.js, sp.js, taxonomy.js)
- creating custom Knockout components
- styling HTML elements to match Fabric UI experience
2021-11-21 02:51:08 -05:00
## Help
We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
If you're having issues building the solution, please run [spfx doctor](https://pnp.github.io/cli-microsoft365/cmd/spfx/spfx-doctor/) from within the solution folder to diagnose incompatibility issues with your environment.
You can try looking at [issues related to this sample](https://github.com/pnp/sp-dev-fx-webparts/issues?q=label%3A%22sample%3A%20knockout-taxonomy%22) to see if anybody else is having the same issues.
You can also try looking at [discussions related to this sample](https://github.com/pnp/sp-dev-fx-webparts/discussions?discussions_q=knockout-taxonomy) and see what the community is saying.
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected%2Csample%3A%20knockout-taxonomy&template=bug-report.yml&sample=knockout-taxonomy&authors=@AJIXuMuK&title=knockout-taxonomy%20-%20).
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aquestion%2Csample%3A%20knockout-taxonomy&template=question.yml&sample=knockout-taxonomy&authors=@AJIXuMuK&title=knockout-taxonomy%20-%20).
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Aenhancement%2Csample%3A%20knockout-taxonomy&template=suggestion.yml&sample=knockout-taxonomy&authors=@AJIXuMuK&title=knockout-taxonomy%20-%20).
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2021-12-20 10:25:30 -05:00
<img src="https://pnptelemetry.azurewebsites.net/sp-dev-fx-webparts/samples/knockout-taxonomy" />