Contents

Props

The settings passed to the component — each one a name, a type, and a value.

Where to find it
Labelled Props in the "Selected Component" section of the Modify drawer.
Offered by
The Custom Component component. Other components do not have this setting.
Per device
Yes — you can set one value for every screen, or separate values for phone, tablet, and desktop.

In plain English

These are the knobs on the component your developer built. Each row is one setting: a name they chose, a type that says how to read the value, and the value itself.

Your developer should give you the list. A typical card looks like: variant (text) — "full" or "compact"; seats (number) — how many to show; showWaitlist (yes/no) — type true or false; theme (JSON) — a small object they wrote down. Type those names exactly. Do not invent a friendlier name; the component will not see it.

Text is ordinary words. Number is a count or a size. Yes / no is true or false, typed exactly that way — not Yes, not 1. JSON is for a structured value your developer described, such as a colour object or a list of ids.

RuleCMS does not know which names the component accepts. If you add a name it does not use, that row is ignored. If you pick the wrong type, that row is ignored too. Nothing breaks; the component just does not see that setting. That is why a setting that "does nothing" is almost always a typo in the name or the wrong type, not a broken page.

What each option does

OptionWhat you will see
TextOrdinary words. The value is used as you typed it.
NumberA count or a size. The value must be a number. Words here are ignored.
Yes / noType true or false, exactly. Yes, no, 1, and 0 are ignored.
JSONA structured value in JSON, such as {"accent":"#0af"} or ["a","b"]. If it does not parse, the row is ignored.

When you would use it

  • A variant, a count, a flag, or any other setting your developer told you this component reads.
  • A value that should differ on phones — a smaller seat count, a compact variant — using the per-device checkbox.
  • Leave Props empty if the component needs no configuration. The name alone is enough for a component that has its own defaults.

How to change it

  1. Get the list of names, types, and example values from your developer.
  2. Click the Custom component on the canvas.
  3. In the Modify drawer, open "Selected Component", then "Props".
  4. Press "Add prop". Type the Name exactly, pick the Type they specified, and fill in the Value.
  5. Repeat for each setting. Remove a row you do not need — an extra name is ignored, but a leftover value you no longer want should not stay.
  6. Uncheck "Same value for all resolutions" if a setting should differ on phones or tablets.
One value, or one per device? Every input in this setting sits under a “Same value for all resolutions” checkbox. Leave it checked for a single value everywhere, or uncheck it to give phones, tablets, and desktops their own. How per-device values work.

Watch out for

  • These values are public. They ship with the page. Do not put passwords, API keys, tokens, or anything secret here.
  • Names that look like onClick, or reserved words such as children, key, and ref, are refused. Those belong to the developer in application code, not to this list.
  • true and false are the only Yes / no values that work. Yes, no, 1, and 0 do nothing.
  • A JSON value that does not parse is ignored. Check the braces and quotes if a setting seems to do nothing.
  • A number that is not a number — "twelve", a blank — is ignored. Use digits, and a decimal point if you need one.
  • Click handlers and other behaviour are not set here. If the component should open a drawer or start checkout, that is your developer's job in the app, not a row on this list.

Related settings

Where to go next