[Ruleset Engine] New fields reference #19214
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| import { useState } from "react"; | ||
| import FieldBadges from "./fields/FieldBadges"; | ||
| import Markdown from "react-markdown"; | ||
|
|
||
| const FieldCatalog = ({ fields }) => { | ||
| const [filters, setFilters] = useState({ | ||
| search: "", | ||
| categories: [], | ||
| keywords: [], | ||
| }); | ||
| const mapped = fields.sort((f1, f2) => { | ||
| return f1.name < f2.name ? -1 : 1; | ||
| }); | ||
|
|
||
| const categories = [ | ||
| ...new Set( | ||
| fields | ||
| .map((field) => field.categories) | ||
| .flat() | ||
| .sort(), | ||
| ), | ||
| ]; | ||
|
|
||
| // apply filters to the fields list | ||
| const fieldList = mapped.filter((field) => { | ||
| if (filters.categories.length > 0) { | ||
| if (!field.categories?.some((c) => filters.categories.includes(c))) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| if (filters.search) { | ||
| // search keywords | ||
| let keywordFound = field.keywords?.some( | ||
| (kw) => kw.indexOf(filters.search) >= 0, | ||
| ); | ||
|
|
||
| if ( | ||
| !field.name.toLowerCase().includes(filters.search.toLowerCase()) && | ||
| !field.summary.toLowerCase().includes(filters.search.toLowerCase()) && | ||
| !keywordFound | ||
| ) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| return true; | ||
| }); | ||
|
|
||
| return ( | ||
| <div className="md:flex"> | ||
| <div className="mr-8 w-full md:w-1/4"> | ||
| <input | ||
| type="text" | ||
| className="mb-8 w-full rounded-md border-2 border-gray-200 bg-white px-2 py-2 dark:border-gray-700 dark:bg-gray-800" | ||
| placeholder="Search fields" | ||
| value={filters.search} | ||
| onChange={(e) => setFilters({ ...filters, search: e.target.value })} | ||
| /> | ||
|
|
||
| <div className="!mb-8 hidden md:block"> | ||
| <span className="text-sm font-bold uppercase text-gray-600 dark:text-gray-200"> | ||
| ▼ Categories | ||
| </span> | ||
|
|
||
| {categories.map((category) => ( | ||
| <label key={category} className="!my-2 block"> | ||
| <input | ||
| type="checkbox" | ||
| className="mr-2" | ||
| value={category} | ||
| onClick={(e) => { | ||
| if (e.target.checked) { | ||
| setFilters({ | ||
| ...filters, | ||
| categories: [...filters.categories, e.target.value], | ||
| }); | ||
| } else { | ||
| setFilters({ | ||
| ...filters, | ||
| categories: filters.categories.filter( | ||
| (f) => f !== e.target.value, | ||
| ), | ||
| }); | ||
| } | ||
| }} | ||
| />{" "} | ||
| {category} | ||
| </label> | ||
| ))} | ||
| </div> | ||
| </div> | ||
|
|
||
| <div className="!mt-0 flex w-full flex-wrap items-stretch gap-[1%] self-start md:w-3/4"> | ||
| {fieldList.length === 0 && ( | ||
| <div className="flex w-full flex-col justify-center rounded-md border bg-gray-50 py-6 text-center align-middle dark:border-gray-500 dark:bg-gray-800"> | ||
| <span className="text-lg !font-bold">No fields found</span> | ||
| <p> | ||
| Try a different search term, or broaden your search by removing | ||
| filters. | ||
| </p> | ||
| </div> | ||
| )} | ||
| {fieldList.map((field) => { | ||
| return ( | ||
| <a | ||
| key={field.name} | ||
| className="mb-3 block w-full self-stretch rounded-md border border-solid border-gray-200 p-3 !text-inherit no-underline hover:bg-gray-50 dark:border-gray-700 dark:hover:bg-gray-800 lg:w-[48%]" | ||
| href={`/ruleset-engine/rules-language/fields/reference/${field.name}/`} | ||
| > | ||
| <div className="-mb-1 flex items-center"> | ||
| <span | ||
| className="font-semibold text-lg text-ellipsis overflow-hidden whitespace-nowrap" | ||
| title={`${field.name}: ${field.data_type}`} | ||
| > | ||
| {field.name} | ||
| </span> | ||
| </div> | ||
| <Markdown | ||
| className="!mt-2 line-clamp-2 text-sm leading-6" | ||
| disallowedElements={["a"]} | ||
| unwrapDisallowed={true} | ||
| > | ||
| {field.summary} | ||
| </Markdown> | ||
|
|
||
| {field.plan_info_label && ( | ||
| <div className="!mt-2 text-xs"> | ||
| <FieldBadges badges={[field.plan_info_label]} /> | ||
| </div> | ||
| )} | ||
| </a> | ||
| ); | ||
| })} | ||
| </div> | ||
| </div> | ||
| ); | ||
| }; | ||
|
|
||
| export default FieldCatalog; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| const FieldBadges = ({ badges }) => { | ||
| return ( | ||
| <ul className="list-none m-0 p-0 inline-flex items-center gap-2 text-xs"> | ||
| {badges.map((badge) => ( | ||
| <li | ||
| key={badge} | ||
| className="bg-gray-100 dark:bg-gray-700 px-2 py-1 rounded-md block !mt-0" | ||
| > | ||
| {badge} | ||
| </li> | ||
| ))} | ||
| </ul> | ||
| ); | ||
| }; | ||
|
|
||
| export default FieldBadges; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR moves this page back to the Magic Firewall tile. There's a separate (inverse) redirect handling this change.