Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 1.0] [OUI DOCS] Updated the content in the section Datagrid and schema #523

Merged
merged 2 commits into from
Feb 28, 2023
Merged

[Backport 1.0] [OUI DOCS] Updated the content in the section Datagrid and schema #523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f05f6ec
[OUI DOCS] Updated the content in the section Datagrid and schema (#288)
AbhishekReddy1127 Feb 27, 2023
dd8de6f
Merge branch '1.0' into backport/backport-288-to-1.0
seanneumann Feb 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src-docs/src/views/datagrid/datagrid_example.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,29 +120,29 @@ const gridSnippet = `
header: 'shade',
}}
// Optional. Provide additional schemas to use in the grid.
// This schema 'franchise' essentially acts like a boolean, looking for Star Wars or Star Trek in a column.
// This schema 'franchise' essentially acts like a boolean, looking for Oranges or Apples in a column.
schemaDetectors={[
{
type: 'franchise',
// Try to detect if column data is this schema. A value of 1 is the highest possible. A (mean_average - standard_deviation) of .5 will be good enough for the autodetector to assign.
detector(value) {
return value.toLowerCase() === 'star wars' ||
value.toLowerCase() === 'star trek'
return value.toLowerCase() === 'oranges' ||
value.toLowerCase() === 'apples'
? 1
: 0;
},
// How we should sort data matching this schema. Again, a value of 1 is the highest value.
comparator(a, b, direction) {
const aValue = a.toLowerCase() === 'star wars';
const bValue = b.toLowerCase() === 'star wars';
const aValue = a.toLowerCase() === 'oranges';
const bValue = b.toLowerCase() === 'oranges';
if (aValue < bValue) return direction === 'asc' ? 1 : -1;
if (aValue > bValue) return direction === 'asc' ? -1 : 1;
return 0;
},
// Text for what the ASC sort does.
sortTextAsc: 'Star Wars-Star Trek',
sortTextAsc: 'Oranges-Apples',
// Text for what the DESC sort does.
sortTextDesc: 'Star Trek-Star Wars',
sortTextDesc: 'Apples-Oranges',
// OuiIcon or Token to signify this schema.
icon: 'star',
// The color to use for the icon token.
Expand Down
32 changes: 16 additions & 16 deletions src-docs/src/views/datagrid/schema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ for (let i = 1; i < 5; i++) {
let json;
let franchise;
if (i < 3) {
franchise = 'Star Wars';
franchise = 'Oranges';
json = JSON.stringify([
{
default: fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}'),
Expand All @@ -64,7 +64,7 @@ for (let i = 1; i < 5; i++) {
},
]);
} else {
franchise = 'Star Trek';
franchise = 'Apples';
json = JSON.stringify([
{
name: fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}'),
Expand All @@ -87,26 +87,26 @@ const Franchise = (props) => {
return (
<div>
<OuiTitle size="s">
<h3>{props.name} is the best!</h3>
<h3>{props.name}</h3>
</OuiTitle>
<OuiSpacer size="s" />
{props.name === 'Star Wars' ? (
{props.name === 'Oranges' ? (
<OuiImage
allowFullScreen
size="m"
hasShadow
caption="Random star wars image"
alt="Random star wars image"
url="https://source.unsplash.com/600x600/?starwars"
caption="Random Oranges image"
alt="Random Oranges image"
url="https://source.unsplash.com/600x600/?oranges"
/>
) : (
<OuiImage
allowFullScreen
size="m"
hasShadow
caption="Random star trek image"
alt="Random trek image"
url="https://source.unsplash.com/600x600/?startrek"
caption="Random Apples image"
alt="Random Apples image"
url="https://source.unsplash.com/600x600/?apples"
/>
)}
</div>
Expand Down Expand Up @@ -193,20 +193,20 @@ const DataGridSchema = () => {
type: 'favoriteFranchise',
textTransform: 'capitalize',
detector(value) {
return value.toLowerCase() === 'star wars' ||
value.toLowerCase() === 'star trek'
return value.toLowerCase() === 'oranges' ||
value.toLowerCase() === 'apples'
? 1
: 0;
},
comparator(a, b, direction) {
const aValue = a.toLowerCase() === 'star wars';
const bValue = b.toLowerCase() === 'star wars';
const aValue = a.toLowerCase() === 'oranges';
const bValue = b.toLowerCase() === 'oranges';
if (aValue < bValue) return direction === 'asc' ? 1 : -1;
if (aValue > bValue) return direction === 'asc' ? -1 : 1;
return 0;
},
sortTextAsc: 'Star wars-Star trek',
sortTextDesc: 'Star trek-Star wars',
sortTextAsc: 'Oranges-Apples',
sortTextDesc: 'Apples-Oranges',
icon: 'starFilled',
color: '#800080',
},
Expand Down