Skip to content

Commit

Permalink
Remove old new version callouts
Browse files Browse the repository at this point in the history
  • Loading branch information
glin committed Dec 4, 2022
1 parent 514ab7a commit 01a00f6
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 61 deletions.
20 changes: 10 additions & 10 deletions vignettes/conditional-styling.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -220,12 +220,12 @@ colDef(
```{r, echo=FALSE, asis=TRUE}
rowInfoProps <- dplyr::tribble(
~Property, ~Example, ~Description,
"values", '{ Petal.Length: 1.7, Species: "setosa" }', "row data values (new in v0.3.0)",
"values", '{ Petal.Length: 1.7, Species: "setosa" }', "row data values",
"row", '{ Petal.Length: 1.7, Species: "setosa" }', tagList("same as ", tags$code("values"), " (deprecated in v0.3.0)"),
"index", "20", "row index (zero-based)",
"viewIndex", "0", "row index within the page (zero-based)",
"aggregated", "true", "whether the row is aggregated",
"expanded", "true", "whether the row is expanded (new in v0.3.0)",
"expanded", "true", "whether the row is expanded",
"subRows", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "sub rows data (aggregated rows only)",
"level", "0", "row nesting depth (zero-based)",
"selected", "true", "whether the row is selected"
Expand All @@ -241,8 +241,8 @@ columnProps <- dplyr::tribble(
~Property, ~Example, ~Description,
"id", '"Petal.Length"', "column ID",
"name", '"Petal Length"', "column display name",
"filterValue", '"petal"', "column filter value (new in v0.3.0)",
"setFilter", 'function setFilter(value: any)', tagList("function to set the column filter value", "(set to ", tags$code("undefined"), " to clear the filter) (new in v0.3.0)")
"filterValue", '"petal"', "column filter value ",
"setFilter", 'function setFilter(value: any)', tagList("function to set the column filter value", "(set to ", tags$code("undefined"), " to clear the filter)")
)
propsTable(columnProps)
Expand All @@ -254,12 +254,12 @@ propsTable(columnProps)
stateProps <- dplyr::tribble(
~Property, ~Example, ~Description,
"sorted", '[{ id: "Petal.Length", desc: true }, ...]', "columns being sorted in the table",
"page", "2", "page index (zero-based, new in v0.3.0)",
"pageSize", "10", "page size (new in v0.3.0)",
"pages", "5", "number of pages (new in v0.3.0)",
"filters", '[{ id: "Species", value: "petal" }]', "column filter values (new in v0.3.0)",
"searchValue", '"petal"', "table search value (new in v0.3.0)",
"selected", '[0, 1, 4]', "selected row indices (zero-based, new in v0.3.0)",
"page", "2", "page index (zero-based)",
"pageSize", "10", "page size",
"pages", "5", "number of pages",
"filters", '[{ id: "Species", value: "petal" }]', "column filter values",
"searchValue", '"petal"', "table search value",
"selected", '[0, 1, 4]', "selected row indices (zero-based)",
"pageRows", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "current row data on the page",
"sortedData", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "current row data in the table (after sorting, filtering, grouping)",
"data", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "original row data in the table",
Expand Down
4 changes: 0 additions & 4 deletions vignettes/custom-filtering.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,6 @@ propsTable <- function(props) {
}
```

::: {.callout}
New in v0.3.0
:::

Custom filter methods and custom filter inputs let you change how filtering is done
in reactable. By default, all filter inputs are text inputs that filter data using
a case-insensitive text match, or for numeric columns, a prefix match.
Expand Down
38 changes: 19 additions & 19 deletions vignettes/custom-rendering.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ colDef(
function(cellInfo, state) {
// input:
// - cellInfo, an object containing cell info
// - state, an object containing the table state (optional, new in v0.3.0)
// - state, an object containing the table state (optional)
//
// output:
// - content to render (e.g. an HTML string)
Expand Down Expand Up @@ -209,11 +209,11 @@ cellInfoProps <- dplyr::tribble(
"index", "20", "row index (zero-based)",
"viewIndex", "0", "row index within the page (zero-based)",
"aggregated", "true", "whether the row is aggregated",
"expanded", "true", "whether the row is expanded (new in v0.3.0)",
"filterValue", '"petal"', "column filter value (new in v0.3.0)",
"expanded", "true", "whether the row is expanded",
"filterValue", '"petal"', "column filter value",
"subRows", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "sub rows data (aggregated cells only)",
"level", "0", "row nesting depth (zero-based)",
"selected", "true", "whether the row is selected (new in v0.3.0)"
"selected", "true", "whether the row is selected"
)
propsTable(cellInfoProps)
Expand All @@ -225,12 +225,12 @@ propsTable(cellInfoProps)
stateProps <- dplyr::tribble(
~Property, ~Example, ~Description,
"sorted", '[{ id: "Petal.Length", desc: true }, ...]', "columns being sorted in the table",
"page", "2", "page index (zero-based, new in v0.3.0)",
"pageSize", "10", "page size (new in v0.3.0)",
"pages", "5", "number of pages (new in v0.3.0)",
"filters", '[{ id: "Species", value: "petal" }]', "column filter values (new in v0.3.0)",
"searchValue", '"petal"', "table search value (new in v0.3.0)",
"selected", '[0, 1, 4]', "selected row indices (zero-based, new in v0.3.0)",
"page", "2", "page index (zero-based)",
"pageSize", "10", "page size",
"pages", "5", "number of pages",
"filters", '[{ id: "Species", value: "petal" }]', "column filter values",
"searchValue", '"petal"', "table search value",
"selected", '[0, 1, 4]', "selected row indices (zero-based)",
"pageRows", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "current row data on the page",
"sortedData", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "current row data in the table (after sorting, filtering, grouping)",
"data", '[{ Petal.Length: 1.7, Species: "setosa" }, ...]', "original row data in the table",
Expand Down Expand Up @@ -271,7 +271,7 @@ colDef(
function(column, state) {
// input:
// - column, an object containing column properties
// - state, an object containing the table state (optional, new in v0.3.0)
// - state, an object containing the table state (optional)
//
// output:
// - content to render (e.g. an HTML string)
Expand All @@ -287,10 +287,10 @@ colDef(
```{r, echo=FALSE, asis=TRUE}
columnProps <- dplyr::tribble(
~Property, ~Example, ~Description,
"id", '"Petal.Length"', "column ID (new in v0.3.0)",
"name", '"Petal Length"', "column display name (new in v0.3.0)",
"filterValue", '"petal"', "column filter value (new in v0.3.0)",
"setFilter", 'function setFilter(value: any)', tagList("function to set the column filter value", "(set to ", tags$code("undefined"), " to clear the filter) (new in v0.3.0)"),
"id", '"Petal.Length"', "column ID",
"name", '"Petal Length"', "column display name",
"filterValue", '"petal"', "column filter value",
"setFilter", 'function setFilter(value: any)', tagList("function to set the column filter value", "(set to ", tags$code("undefined"), " to clear the filter)"),
"column", '{ id: "Petal.Length", name: "Petal Length", filterValue: "petal" }', "column info object (deprecated in v0.3.0)",
"data", '[{ Petal.Length: 1.7, Petal.Width: 0.2, _subRows: [] }, ...]', "current row data in the table (deprecated in v0.3.0)"
)
Expand Down Expand Up @@ -334,7 +334,7 @@ colDef(
function(column, state) {
// input:
// - column, an object containing column properties
// - state, an object containing the table state (optional, new in v0.3.0)
// - state, an object containing the table state (optional)
//
// output:
// - content to render (e.g. an HTML string)
Expand Down Expand Up @@ -390,7 +390,7 @@ reactable(
function(rowInfo, state) {
// input:
// - rowInfo, an object containing row info
// - state, an object containing the table state (optional, new in v0.3.0)
// - state, an object containing the table state (optional)
//
// output:
// - content to render (e.g. an HTML string)
Expand All @@ -405,11 +405,11 @@ reactable(
```{r, echo=FALSE, asis=TRUE}
rowInfoProps <- dplyr::tribble(
~Property, ~Example, ~Description,
"values", '{ Petal.Length: 1.7, Species: "setosa" }', "row data values (new in v0.3.0)",
"values", '{ Petal.Length: 1.7, Species: "setosa" }', "row data values",
"row", '{ Petal.Length: 1.7, Species: "setosa" }', tagList("same as ", tags$code("values"), " (deprecated in v0.3.0)"),
"index", "20", "row index (zero-based)",
"viewIndex", "0", "row index within the page (zero-based)",
"expanded", "true", "whether the row is expanded (new in v0.3.0)",
"expanded", "true", "whether the row is expanded",
"level", "0", "row nesting depth (zero-based)",
"selected", "true", "whether the row is selected"
)
Expand Down
24 changes: 0 additions & 24 deletions vignettes/examples.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -441,10 +441,6 @@ reactable(

### Include sub rows in pagination

::: {.callout}
New in v0.3.0
:::

By default, sub rows are excluded from pagination and always shown on the same
page when expanded. To include sub rows in pagination, you can set `paginateSubRows`
to `TRUE`. This is recommended for grouped tables with a large number of rows
Expand Down Expand Up @@ -715,10 +711,6 @@ reactable(data, columns = list(

### Grouped cell rendering

::: {.callout}
New in v0.3.0
:::

```{r}
data <- MASS::Cars93[10:22, c("Manufacturer", "Model", "Type", "Price", "MPG.city")]
Expand Down Expand Up @@ -1384,10 +1376,6 @@ reactable(

### Vertical alignment

::: {.callout}
New in v0.3.0
:::

You can change the vertical alignment of cell content using the `vAlign` or
`headerVAlign` arguments in `colDef()` and `colGroup()`. `vAlign` controls the
alignment of data cells, while `headerVAlign` controls the alignment of header cells.
Expand Down Expand Up @@ -1662,10 +1650,6 @@ reactable(MASS::Cars93[1:5, ], resizable = TRUE, wrap = FALSE, bordered = TRUE)

## Sticky Columns

::: {.callout}
New in v0.3.0
:::

You can make columns sticky when scrolling horizontally using the `sticky`
argument in `colDef()` or `colGroup()`. Set `sticky` to either `"left"`
or `"right"` to make the column stick to the left or right side.
Expand Down Expand Up @@ -1767,10 +1751,6 @@ reactable(iris[1:5, ], rownames = TRUE)

### Row headers

::: {.callout}
New in v0.3.0
:::

You can mark up cells in a column as row headers by setting `rowHeader` to `TRUE`
in `colDef()`.

Expand Down Expand Up @@ -2308,10 +2288,6 @@ htmltools::browsable(

## JavaScript API

::: {.callout}
New in v0.3.0
:::

You can use the JavaScript API to create custom interactive controls for your table
without the use of Shiny, or add cross-widget interactions beyond what Crosstalk provides.

Expand Down
4 changes: 0 additions & 4 deletions vignettes/javascript-api.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,6 @@ propsTable <- function(props) {
}
```

::: {.callout}
New in v0.3.0
:::

## Introduction

The JavaScript API lets you manipulate and access tables from JavaScript.
Expand Down

0 comments on commit 01a00f6

Please sign in to comment.